alchemy-pg_search 4.1.1 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 828c2a8af31cad65403c88864ee11200cd85d0a9c45752b850aecddd045bde5d
-  data.tar.gz: fb5848d9f666566521788b6c72439b436bfde28a44e3a097b6a0316ad7297d0d
+  metadata.gz: 1896b14c7a0f65b1b14ca0f2de751ee14c68219bbd24893f6561725ab69fd622
+  data.tar.gz: 8e5759cd3d6f12f57c544ba5a2290d98f5600808f61b9e03e9ae3530a9e6aaaf
 SHA512:
-  metadata.gz: 5476bef5b1fd765d8a1557c5c7530f3ec9c4261751054f02b2b73c2b3900d1252ade1bd27a642bef9cbc85fb6a54522ccf13274633e8af7f974ea587cfaea544
-  data.tar.gz: 41c2a772efe484abec82ec3928fea14f8d1a86f2b703748c4f7223f66a56d8182a074b4430a541242b3ad15d9acde85e5d53e099987da7cad900f74f90a946dc
+  metadata.gz: 6fb5a90e1e4a562dd4c71cabbb91dc173be473e2eb2100fe83b0d317f6c6120bf2af66589a369fd0a39355f3996811e80e2399320c7e19c44eb6f1ac8e5c0830
+  data.tar.gz: cc3d81d2e4e798b57e47109890b8e97f40a12c16e33446887789ee3f5aa377d68ab4c58430834adfc2e75f2b12f4a57afa6348d2372af9464a91658dc5d84570

data/.github/workflows/ci.yml

@@ -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.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)
+
+**Merged pull requests:**
+
+- Update to Alchemy 6.1 [\#38](https://github.com/AlchemyCMS/alchemy-pg_search/pull/38) ([kulturbande](https://github.com/kulturbande))
+- Page searchable toggle [\#37](https://github.com/AlchemyCMS/alchemy-pg_search/pull/37) ([kulturbande](https://github.com/kulturbande))
+
 ## [v4.1.1](https://github.com/AlchemyCMS/alchemy-pg_search/tree/v4.1.1) (2022-09-20)
 
 [Full Changelog](https://github.com/AlchemyCMS/alchemy-pg_search/compare/v4.1.0...v4.1.1)

data/Gemfile

@@ -2,13 +2,11 @@ source "https://rubygems.org"
 
 gemspec
 
-gem "rails", "~> 6.0.0"
-ENV.fetch("ALCHEMY_BRANCH", "6.0-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/README.md

@@ -26,7 +26,7 @@ $ bin/rails g alchemy:pg_search:install
 
 ## 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 +51,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 +63,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 +76,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.'

data/alchemy-pg_search.gemspec

@@ -16,7 +16,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", [">= 6.0", "< 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/controller/alchemy/pg_search/controller_methods.rb

@@ -70,11 +70,14 @@ module Alchemy
       end
 
       def search_result_page_layout
-        page_layout = PageLayout.get_all_by_attributes(searchresults: true).first
-        if page_layout.nil?
+        # search for page layout with the attribute `searchresults: true`
+        page_layouts = PageLayout.all.select do |page_layout|
+          page_layout.key?(:searchresults) && page_layout[:searchresults].to_s.casecmp(true.to_s).zero?
+        end
+        if page_layouts.nil?
           raise "No searchresults page layout found. Please add page layout with `searchresults: true` into your `page_layouts.yml` file."
         end
-        page_layout
+        page_layouts.first
       end
 
       def paginate_per

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/app/extensions/alchemy/pg_search/page_extension.rb

@@ -17,7 +17,7 @@ module Alchemy::PgSearch::PageExtension
 
   def searchable?
     (definition.key?(:searchable) ? definition[:searchable] : true) &&
-      public? && !layoutpage?
+      searchable && public? && !layoutpage?
   end
 
   private

data/lib/alchemy/pg_search/engine.rb

@@ -17,6 +17,9 @@ module Alchemy
         # reindex the page after it was published
         Alchemy.publish_targets << Alchemy::PgSearch::IndexPageJob
 
+        # enable searchable flag in page form
+        Alchemy.enable_searchable = true
+
         # configure multiselect to find also partial words
         # @link https://github.com/Casecommons/pg_search#searching-using-different-search-features
         ::PgSearch.multisearch_options = {

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.1.1"
+    VERSION = "5.0.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.1.1
+  version: 5.0.0
 platform: ruby
 authors:
 - Thomas von Deyen
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-09-20 00:00:00.000000000 Z
+date: 2023-09-01 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.0'
+        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.0'
+        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
@@ -165,7 +161,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+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)
-