alchemy-pg_search 6.0.0 → 7.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '009bedc83da970afa4e20ea64375695711b50ef37027b4e4cbe08a7add274070'
-  data.tar.gz: c324b6915704b0ef189d539510d57ff80962be5f6244907bbfd9d82e0d13eec8
+  metadata.gz: 9e00888216dd93910987461a26a8638880587c9ada33cf2406216dea03e05554
+  data.tar.gz: 8c96b6b2bafec9df42017106b016587d62c51b33d462c0674218b39d06168033
 SHA512:
-  metadata.gz: 0eda59775b10f840a97362c244beb387e259e104d18f03e855984ea15437649d78c1a397a4a2f443e62c62bbd74f42288b77ce7ede6401d090ae28b1d3844d06
-  data.tar.gz: 6245d3b156a31fe0459fc9372de9c3ffc8ab7f123dd717402a7dc3aeb206876912069f88ae4d20a127039ee1754d45f87c6391633490f8363dde101a2cb8fb10
+  metadata.gz: 19e2ac77874ac9a99110419d813f907ee8895f83cfc91140bf3c4af9451e95a722e10e5a87a3379caa30e65bff2c3ba6314e0fe7f719aec5029bd231638de00d
+  data.tar.gz: 7465ebc5e8b3080a3551e686ac31917da67bdd226ebe8e9aee49d15259b2eaa562f7d7ea6f97f387139e94cf28f48f91193af5afc0c0f1c2a7d2117c4c9dd1d6

data/.github/workflows/ci.yml

@@ -1,12 +1,26 @@
 name: CI
 
-on: [push, pull_request]
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref_name }}
+  cancel-in-progress: ${{ github.ref_name != 'main' }}
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
 
 jobs:
   RSpec:
     runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: ["3.2", "3.4"]
+        alchemy_cms: ["7.4"]
     env:
       RAILS_ENV: test
+      ALCHEMY_CMS_VERSION: ${{ matrix.alchemy_cms }}
     services:
       postgres:
         image: postgres:12
@@ -18,10 +32,12 @@ jobs:
         options: --health-cmd pg_isready --health-interval 10s --health-timeout 5s --health-retries 5
     steps:
       - uses: actions/checkout@v2.3.4
+      - name: Install ImageMagick
+        run: sudo apt-get install -y imagemagick
       - name: Set up Ruby
         uses: ruby/setup-ruby@v1
         with:
-          ruby-version: 3.2
+          ruby-version: ${{ matrix.ruby }}
           bundler-cache: true
       - name: Prepare database
         run: bundle exec rake alchemy:spec:prepare

data/.github/workflows/post-release.yml

@@ -0,0 +1,27 @@
+name: Post Release
+
+on:
+  workflow_dispatch:
+    inputs:
+      target_branch:
+        description: 'Target branch (e.g., main, 8.0-stable)'
+        required: true
+        default: 'main'
+        type: string
+  repository_dispatch:
+    types: [post-release]
+
+jobs:
+  post-release:
+    uses: AlchemyCMS/.github/.github/workflows/post-release.yml@main
+    with:
+      version_file_path: lib/alchemy/pg_search/version.rb
+      target_branch: ${{ github.event.client_payload.target_branch || inputs.target_branch }}
+    secrets:
+      app_id: ${{ vars.ALCHEMY_BOT_APP_ID }}
+      app_private_key: ${{ secrets.ALCHEMY_BOT_APP_PRIVATE_KEY }}
+      slack_webhook_url: ${{ secrets.SLACK_WEBHOOK_URL }}
+      mastodon_access_token: ${{ secrets.MASTODON_ACCESS_TOKEN }}
+      mastodon_instance: ${{ secrets.MASTODON_INSTANCE }}
+      bluesky_identifier: ${{ secrets.BLUESKY_IDENTIFIER }}
+      bluesky_password: ${{ secrets.BLUESKY_PASSWORD }}

data/.github/workflows/prepare-release.yml

@@ -0,0 +1,25 @@
+name: Prepare Release
+
+on:
+  workflow_dispatch:
+    inputs:
+      bump:
+        description: 'Version bump type. Choose "release" for finalizing a pre-release, or patch/minor/major to bump version.'
+        required: true
+        type: choice
+        default: 'patch'
+        options:
+          - release
+          - patch
+          - minor
+          - major
+
+jobs:
+  prepare:
+    uses: AlchemyCMS/.github/.github/workflows/prepare-release.yml@main
+    with:
+      version_file_path: lib/alchemy/pg_search/version.rb
+      bump: ${{ inputs.bump }}
+    secrets:
+      app_id: ${{ vars.ALCHEMY_BOT_APP_ID }}
+      app_private_key: ${{ secrets.ALCHEMY_BOT_APP_PRIVATE_KEY }}

data/.github/workflows/release.yml

@@ -0,0 +1,20 @@
+name: Publish Release
+
+on:
+  workflow_dispatch:
+  pull_request:
+    types: [closed]
+    branches:
+      - main
+
+jobs:
+  publish:
+    if: github.event_name == 'workflow_dispatch' || (github.event.pull_request.merged == true && startsWith(github.event.pull_request.head.ref, 'release/v'))
+    uses: AlchemyCMS/.github/.github/workflows/release.yml@main
+    with:
+      version_file_path: lib/alchemy/pg_search/version.rb
+      target_branch: ${{ github.event.pull_request.base.ref || github.ref_name }}
+    secrets:
+      app_id: ${{ vars.ALCHEMY_BOT_APP_ID }}
+      app_private_key: ${{ secrets.ALCHEMY_BOT_APP_PRIVATE_KEY }}
+      rubygems_api_key: ${{ secrets.RUBYGEMS_API_KEY }}

data/CHANGELOG.md

@@ -1,5 +1,23 @@
 # Changelog
 
+## 7.4.0 (2026-03-17)
+
+## 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
+
+
+**Full Changelog**: https://github.com/AlchemyCMS/alchemy-pg_search/compare/v6.1.0...v7.4.0
+
+## [v6.1.0](https://github.com/AlchemyCMS/alchemy-pg_search/tree/v6.1.0) (2024-12-13)
+
+[Full Changelog](https://github.com/AlchemyCMS/alchemy-pg_search/compare/v6.0.0...v6.1.0)
+
+**Merged pull requests:**
+
+- Use PgSearch::Document.rebuild for page reindex [\#63](https://github.com/AlchemyCMS/alchemy-pg_search/pull/63) ([sascha-karnatz](https://github.com/sascha-karnatz))
+
 ## [v6.0.0](https://github.com/AlchemyCMS/alchemy-pg_search/tree/v6.0.0) (2024-12-03)
 
 [Full Changelog](https://github.com/AlchemyCMS/alchemy-pg_search/compare/v5.2.0...v6.0.0)

data/Gemfile

@@ -3,7 +3,7 @@ source "https://rubygems.org"
 gemspec
 
 gem "rails", "~> 7.1.0"
-gem "alchemy_cms", "~> 7.0.0"
+gem "alchemy_cms", "~> #{ENV.fetch("ALCHEMY_CMS_VERSION", "7.4")}.0"
 
 gem "sassc-rails"
 gem "sassc", "~> 2.4.0"
@@ -11,7 +11,7 @@ gem "pg", "~> 1.0"
 gem "puma"
 
 group :test do
-  gem "factory_bot_rails", "~> 4.8.0"
+  gem "factory_bot_rails", "~> 6.5.1"
   gem "capybara"
   gem "pry-byebug"
   gem "launchy"

data/README.md

@@ -209,6 +209,19 @@ en:
 
 ## Upgrading
 
+## 6.0
+
+Upgrading to 6.0 makes it necessary to update you search result partials.
+
+Make sure to use `Alchemy::Search::SearchPage.perform_search(params, ability: current_ability)` and pass the `search_results` into `alchemy/search/results` (or whatever partial you are rendering the results) and make sure to use the local `search_results` variable over the `@search_results` instance variable.
+
+```diff
+-<%= render "alchemy/search/results" %>
++<%= render "alchemy/search/results", search_results: Alchemy::Search::SearchPage.perform_search(params, ability: current_ability) %>
+```
+
+## 4.0
+
 If you are upgrading from v3.0.0 please run the install generator:
 
 ```shell

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

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

@@ -6,24 +6,18 @@ module Alchemy::PgSearch::PageExtension
     base.after_save :remove_unpublished_page
     base.multisearchable(
       against: [
-        :meta_description,
-        :meta_keywords,
         :name,
+        :searchable_content
       ],
       additional_attributes: ->(page) { { page_id: page.id, searchable_created_at: page.public_on } },
       if: :searchable?,
     )
   end
 
-  def searchable?
-    (definition.key?(:searchable) ? definition[:searchable] : true) &&
-      searchable && public? && !layoutpage?
-  end
-
   private
 
   def remove_unpublished_page
-    Alchemy::PgSearch.remove_page(self) unless searchable?
+    ::PgSearch::Document.delete_by(page_id: id) unless searchable?
   end
 end
 

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

@@ -10,6 +10,10 @@ module Alchemy::Search::ElementExtension
   def searchable?
     searchable && public? && page.searchable? && page_version.public?
   end
+
+  def searchable_content
+    ingredients.select(&:searchable?).map(&:searchable_content).join(" ").squish
+  end
 end
 
 Alchemy::Element.prepend(Alchemy::Search::ElementExtension)

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

@@ -5,6 +5,10 @@ module Alchemy::Search::PageExtension
     (definition.key?(:searchable) ? definition[:searchable] : true) &&
       searchable && public? && !layoutpage?
   end
+
+  def searchable_content
+    all_elements.includes(ingredients: {element: :page}).map(&:searchable_content).join(" ")
+  end
 end
 
 Alchemy::Page.prepend(Alchemy::Search::PageExtension)

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

@@ -2,7 +2,7 @@ module Alchemy
   module PgSearch
     class IndexPageJob < BaseJob
       def perform(page)
-        PgSearch.index_page(page)
+        page.update_pg_search_document
       end
     end
   end

data/lib/alchemy/pg_search/version.rb

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

data/lib/alchemy-pg_search.rb

@@ -17,37 +17,13 @@ module Alchemy
     extend Config
 
     ##
-    # index all supported Alchemy pages
-    def self.rebuild
-      ActiveRecord::Base.transaction do
-        ::PgSearch::Document.delete_all
-        Alchemy::Page.all.each{ |page| index_page(page) }
-      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 ingredients
-    #
-    # @param page [Alchemy::Page]
-    def self.index_page(page)
-      page.update_pg_search_document
-
-      document = page.pg_search_document
-      return if document.nil?
-
-      ingredient_content = page.all_elements.includes(ingredients: {element: :page}).map do |element|
-        element.ingredients.select { |i| i.searchable? }.map(&:searchable_content).join(" ")
-      end.join(" ")
-
-      document.update_column(:content, "#{document.content} #{ingredient_content}".squish)
+    # Reindex all supported Alchemy pages
+    def self.rebuild(clean_up: true, transactional: true)
+      ::PgSearch::Multisearch.rebuild(
+        Alchemy::Page,
+        clean_up: clean_up,
+        transactional: transactional
+      )
     end
 
     ##

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: alchemy-pg_search
 version: !ruby/object:Gem::Version
-  version: 6.0.0
+  version: 7.4.0
 platform: ruby
 authors:
 - Thomas von Deyen
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-03 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: alchemy_cms
@@ -16,7 +15,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '7.4'
     - - "<"
       - !ruby/object:Gem::Version
         version: '8'
@@ -26,7 +25,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '7.4'
     - - "<"
       - !ruby/object:Gem::Version
         version: '8'
@@ -108,6 +107,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/workflows/ci.yml"
+- ".github/workflows/post-release.yml"
+- ".github/workflows/prepare-release.yml"
+- ".github/workflows/release.yml"
 - ".gitignore"
 - CHANGELOG.md
 - Gemfile
@@ -144,7 +146,6 @@ homepage: https://alchemy-cms.com
 licenses:
 - BSD-3-Clause
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -160,8 +161,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements:
 - PostgreSQL >= 12.x
-rubygems_version: 3.4.19
-signing_key:
+rubygems_version: 4.0.6
 specification_version: 4
 summary: This gem provides PostgreSQL full text search to Alchemy
 test_files: []