alchemy_cms 6.1.0 → 6.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d85d573a2ae43f5152d2ae9082b0548f6cd4611b51f73aee187d796a037fb55e
-  data.tar.gz: 4d30a22cd1c6945e1fe51fdb68c94d716b623d297c6750643518bb291041fb1a
+  metadata.gz: 143bb006641791929e37a72fd82d200d10084c85e9685934776e54dc61e08f58
+  data.tar.gz: 2a8a82d5f452822f394ee9af1d55eca46efa4772a269e09583de154addc8be5f
 SHA512:
-  metadata.gz: a2381b9af6f92c97955d9415f6d79160cd6940edfa01be10c28ddf7e1166416216e009d903ebf680fc6d788edb6b60f1019f6cbfdc252c1cc8b7829c49369607
-  data.tar.gz: 19a66a2d66bf5d34020a3e59a440baeb7d305dde3bc9681eb609cfef7862b58b7628b258683185f0b3fdb49d3abc89d3a0a4b1b40e4a7480129ca93f09980845
+  metadata.gz: fd987d8e08a1813c1f6b3ae50904910e1cb8c60c2a1a0ad5906ef9b0cdd3a233c71871e7c3b6b00f10b5caa8f56169c060cd61f03a1f0231b8ae85d7b1ff44b6
+  data.tar.gz: 9dae2d9dabe3c81da44d17ddfc4ddb8713a328927e07caef81d6c42aba2445a9854262fa12f55f74e3cd11960197ed183bbb898a363c7ff9b3dd5ef175b91743

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## 6.1.1 (2023-01-23)
+
+- Re-introduce deleted methods [#2422](https://github.com/AlchemyCMS/alchemy_cms/pull/2422) ([tvdeyen](https://github.com/tvdeyen))
+- Add searchable field to page (Alchemy 6.1) [#2420](https://github.com/AlchemyCMS/alchemy_cms/pull/2420) ([kulturbande](https://github.com/kulturbande))
+
 ## 6.1.0 (2023-01-19)
 
 ### Features

data/app/helpers/alchemy/elements_helper.rb

@@ -166,6 +166,14 @@ module Alchemy
       render "alchemy/elements/view_not_found", name: element.name
     end
 
+    # Returns a string for the id attribute of a html element for the given element
+    # @deprecated
+    def element_dom_id(element)
+      element&.dom_id
+    end
+
+    deprecate element_dom_id: "element.dom_id", deprecator: Alchemy::Deprecation
+
     # Renders the HTML tag attributes required for preview mode.
     def element_preview_code(element)
       tag_builder.tag_options(element_preview_code_attributes(element))

data/app/models/alchemy/element/element_contents.rb

@@ -6,29 +6,41 @@ module Alchemy
     #
     module ElementContents
       # Find first content from element by given name.
+      # @deprecated
       def content_by_name(name)
         contents_by_name(name).first
       end
 
+      deprecate content_by_name: :ingredient_by_role, deprecator: Alchemy::Deprecation
+
       # Find first content from element by given essence type.
+      # @deprecated
       def content_by_type(essence_type)
         contents_by_type(essence_type).first
       end
 
+      deprecate content_by_type: :ingredient_by_type, deprecator: Alchemy::Deprecation
+
       # All contents from element by given name.
+      # @deprecated
       def contents_by_name(name)
         contents.select { |content| content.name == name.to_s }
       end
 
+      deprecate contents_by_name: :ingredients_by_role, deprecator: Alchemy::Deprecation
+
       alias_method :all_contents_by_name, :contents_by_name
 
       # All contents from element by given essence type.
+      # @deprecated
       def contents_by_type(essence_type)
         contents.select do |content|
           content.essence_type == Content.normalize_essence_type(essence_type)
         end
       end
 
+      deprecate contents_by_type: :ingredients_by_type, deprecator: Alchemy::Deprecation
+
       alias_method :all_contents_by_type, :contents_by_type
 
       # Updates all related contents by calling +update_essence+ on each of them.
@@ -48,6 +60,7 @@ module Alchemy
       #     "2" => {link: "https://google.com"}
       #   )
       #
+      # @deprecated
       def update_contents(contents_attributes)
         return true if contents_attributes.nil?
 
@@ -58,13 +71,18 @@ module Alchemy
         errors.blank?
       end
 
+      deprecate :update_contents, deprecator: Alchemy::Deprecation
+
       # Copy current content's contents to given target element
+      # @deprecated
       def copy_contents_to(element)
         contents.map do |content|
           Content.copy(content, element_id: element.id)
         end
       end
 
+      deprecate :copy_contents_to, deprecator: Alchemy::Deprecation
+
       # Returns the content that is marked as rss title.
       #
       # Mark a content as rss title in your +elements.yml+ file:
@@ -75,10 +93,13 @@ module Alchemy
       #       type: EssenceText
       #       rss_title: true
       #
+      # @deprecated
       def content_for_rss_title
         content_for_rss_meta("title")
       end
 
+      deprecate :content_for_rss_title, deprecator: Alchemy::Deprecation
+
       # Returns the content that is marked as rss description.
       #
       # Mark a content as rss description in your +elements.yml+ file:
@@ -89,18 +110,25 @@ module Alchemy
       #       type: EssenceRichtext
       #       rss_description: true
       #
+      # @deprecated
       def content_for_rss_description
         content_for_rss_meta("description")
       end
 
+      deprecate :content_for_rss_description, deprecator: Alchemy::Deprecation
+
       # Returns the array with the hashes for all element contents in the elements.yml file
+      # @deprecated
       def content_definitions
         return nil if definition.blank?
 
         definition["contents"]
       end
 
+      deprecate content_definitions: :ingredient_definitions, deprecator: Alchemy::Deprecation
+
       # Returns the definition for given content_name
+      # @deprecated
       def content_definition_for(content_name)
         if content_definitions.blank?
           log_warning "Element #{name} is missing the content definition for #{content_name}"
@@ -110,10 +138,13 @@ module Alchemy
         end
       end
 
+      deprecate content_definition_for: :ingredient_definition_for, deprecator: Alchemy::Deprecation
+
       # Returns an array of all EssenceRichtext contents ids from elements
       #
       # This is used to re-initialize the TinyMCE editor in the element editor.
       #
+      # @deprecated
       def richtext_contents_ids
         # This is not very efficient SQL wise I know, but we need to iterate
         # recursivly through all descendent elements and I don't know how to do this
@@ -126,16 +157,24 @@ module Alchemy
         ids.flatten
       end
 
+      deprecate richtext_contents_ids: :richtext_ingredients_ids, deprecator: Alchemy::Deprecation
+
       # True, if any of the element's contents has essence validations defined.
+      # @deprecated
       def has_validations?
         !contents.detect(&:has_validations?).blank?
       end
 
+      deprecate :has_validations?, deprecator: Alchemy::Deprecation
+
       # All element contents where the essence validation has failed.
+      # @deprecated
       def contents_with_errors
         contents.select(&:essence_validation_failed?)
       end
 
+      deprecate contents_with_errors: :ingredients_with_errors, deprecator: Alchemy::Deprecation
+
       private
 
       def content_for_rss_meta(type)

data/app/models/alchemy/element/element_essences.rb

@@ -7,7 +7,7 @@ module Alchemy
       def ingredient(name)
         ing = ingredient_by_role(name)
         if ing
-          Alchemy::Deprecation.warn <<~WARN
+          Alchemy::Deprecation.warn(<<~WARN)
             Using `element.ingredient` to get the value of an ingredient is deprecated and will change in Alchemy 6.1
             If you want to read the value of an elements ingredient please use `element.value_for(:ingredient_role)` instead.
             The next version of Alchemy will return a `Alchemy::Ingredient` record instead.
@@ -23,9 +23,11 @@ module Alchemy
 
       # True if the element has a content for given name,
       # that has an essence value (aka. ingredient) that is not blank.
+      # @deprecated
       def has_ingredient?(name)
         ingredient(name).present?
       end
+
       deprecate has_ingredient?: :has_value_for?, deprecator: Alchemy::Deprecation
 
       # Returns all essence errors in the format of:
@@ -39,6 +41,7 @@ module Alchemy
       #
       # Get translated error messages with +Element#essence_error_messages+
       #
+      # @deprecated
       def essence_errors
         essence_errors = {}
         contents.each do |content|
@@ -49,6 +52,8 @@ module Alchemy
         essence_errors
       end
 
+      deprecate :essence_errors, deprecator: Alchemy::Deprecation
+
       # Essence validation errors
       #
       # == Error messages are translated via I18n
@@ -103,6 +108,7 @@ module Alchemy
       #           invalid: %{field} has wrong format
       #           blank: %{field} can't be blank
       #
+      # @deprecated
       def essence_error_messages
         messages = []
         essence_errors.each do |content_name, errors|
@@ -120,6 +126,8 @@ module Alchemy
         end
         messages
       end
+
+      deprecate essence_error_messages: :ingredient_error_messages, deprecator: Alchemy::Deprecation
     end
   end
 end

data/app/models/alchemy/element/element_ingredients.rb

@@ -37,6 +37,13 @@ module Alchemy
         ingredients_by_type(type).first
       end
 
+      # All ingredients from element by given role.
+      def ingredients_by_role(role)
+        ingredients.select do |ingredient|
+          ingredient.role == Ingredient.normalize_type(role)
+        end
+      end
+
       # All ingredients from element by given type.
       def ingredients_by_type(type)
         ingredients.select do |ingredient|

data/app/models/alchemy/element.rb

@@ -61,6 +61,8 @@ module Alchemy
 
     has_many :contents, dependent: :destroy, inverse_of: :element
 
+    deprecate contents: :ingredients, deprecator: Alchemy::Deprecation
+
     before_destroy :delete_all_nested_elements
 
     has_many :all_nested_elements,
@@ -103,6 +105,7 @@ module Alchemy
     scope :published, -> { where(public: true) }
     scope :hidden, -> { where(public: false) }
     scope :not_restricted, -> { joins(:page).merge(Page.not_restricted) }
+    scope :available, -> { published }
     scope :named, ->(names) { where(name: names) }
     scope :excluded, ->(names) { where.not(name: names) }
     scope :fixed, -> { where(fixed: true) }
@@ -189,6 +192,8 @@ module Alchemy
 
         all_from_clipboard(clipboard).where(name: parent_element.definition["nestable_elements"])
       end
+
+      deprecate available: :published, deprecator: Alchemy::Deprecation
     end
 
     # Returns next public element from same page.

data/app/models/alchemy/page.rb

@@ -79,6 +79,7 @@ module Alchemy
       :restricted,
       :robot_index,
       :robot_follow,
+      :searchable,
       :sitemap,
       :tag_list,
       :title,

data/app/views/alchemy/admin/pages/_form.html.erb

@@ -19,6 +19,15 @@
   <%= f.input :title,
     input_html: {'data-alchemy-char-counter' => 60} %>
 
+  <% if Alchemy.enable_searchable %>
+    <div class="input check_boxes">
+      <label class="control-label"><%= Alchemy.t(:fulltext_search) %></label>
+      <div class="control_group">
+        <%= page_status_checkbox(@page, :searchable) %>
+      </div>
+    </div>
+  <% end %>
+
   <div class="input check_boxes">
     <label class="control-label"><%= Alchemy.t(:search_engines) %></label>
     <div class="control_group">

data/config/locales/alchemy.en.yml

@@ -594,6 +594,7 @@ en:
     saved_link: "Link saved."
     search: "search"
     search_engines: "Search engines"
+    fulltext_search: "Fulltext search"
     select_element: "Select element"
     seperate_tags_with_comma: "Seperate tags with comma"
     show_element_content: "Show content of this element."
@@ -879,6 +880,7 @@ en:
         page_layout: "Page type"
         public: "public"
         restricted: "restricted"
+        searchable: "show in search"
         robot_follow: "robot may follow links"
         robot_index: "allow robot to index"
         sitemap: "visible in sitemap"

data/db/migrate/20230123112425_add_searchable_to_alchemy_pages.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+class AddSearchableToAlchemyPages < ActiveRecord::Migration[6.0]
+  def change
+    return if column_exists?(:alchemy_pages, :searchable)
+
+    add_column :alchemy_pages, :searchable, :boolean, default: true, null: false
+  end
+end

data/lib/alchemy/deprecation.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module Alchemy
-  Deprecation = ActiveSupport::Deprecation.new("6.1", "Alchemy")
+  Deprecation = ActiveSupport::Deprecation.new("7.0", "Alchemy")
 end

data/lib/alchemy/upgrader/tasks/add_page_versions.rb

@@ -15,10 +15,10 @@ module Alchemy::Upgrader::Tasks
             Alchemy::Page.transaction do
               page.versions.create!(
                 public_on: page.legacy_public_on,
-                public_until: page.legacy_public_until,
+                public_until: page.legacy_public_until
               ).tap do |version|
                 # We must not use .find_each here to not mess up the order of elements
-                page.draft_version.elements.not_nested.published.each do |element|
+                page.draft_version.elements.not_nested.available.each do |element|
                   Alchemy::Element.copy(element, page_version_id: version.id)
                 end
               end

data/lib/alchemy/version.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Alchemy
-  VERSION = "6.1.0"
+  VERSION = "6.1.1"
 
   def self.version
     VERSION

data/lib/alchemy.rb

@@ -84,4 +84,17 @@ module Alchemy
   def self.publish_targets
     @_publish_targets ||= Set.new
   end
+
+  # Enable full text search configuration
+  #
+  # It enables a searchable checkbox in the page form to toggle
+  # the searchable field. These information can used in a search
+  # plugin (e.g. https://github.com/AlchemyCMS/alchemy-pg_search).
+  #
+  # == Example
+  #
+  #     # config/initializers/alchemy.rb
+  #     Alchemy.enable_searchable = true
+  #
+  mattr_accessor :enable_searchable, default: false
 end

data/lib/generators/alchemy/elements/templates/view.html.erb

@@ -19,7 +19,7 @@
     <%- end -%>
   <%- end -%>
   <%- if @element['nestable_elements'].present? -%>
-    <%%= render <%= @element_name %>.nested_elements.published %>
+    <%%= render <%= @element_name %>.nested_elements.available %>
   <%- end -%>
   <%%- end -%>
 <%%- end -%>

data/lib/generators/alchemy/elements/templates/view.html.haml

@@ -18,5 +18,5 @@
     <%- end -%>
   <%- end -%>
   <%- if @element['nestable_elements'].present? -%>
-    = render <%= @element_name -%>.nested_elements.published
+    = render <%= @element_name -%>.nested_elements.available
   <%- end -%>

data/lib/generators/alchemy/elements/templates/view.html.slim

@@ -18,5 +18,5 @@
     <%- end -%>
   <%- end -%>
   <%- if @element['nestable_elements'].present? -%>
-    = render <%= @element_name -%>.nested_elements.published
+    = render <%= @element_name -%>.nested_elements.available
   <%- end -%>

data/lib/tasks/alchemy/thumbnails.rake

@@ -46,7 +46,7 @@ namespace :alchemy do
       ingredient_pictures = Alchemy::Ingredients::Picture.
         joins(:element).
         preload({ related_object: :thumbs }).
-        merge(Alchemy::Element.published)
+        merge(Alchemy::Element.available)
 
       if ENV["ELEMENTS"].present?
         ingredient_pictures = ingredient_pictures.merge(

data/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alchemy_cms/admin",
-  "version": "6.1.0",
+  "version": "6.1.1",
   "description": "AlchemyCMS",
   "browser": "package/admin.js",
   "files": [

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: alchemy_cms
 version: !ruby/object:Gem::Version
-  version: 6.1.0
+  version: 6.1.1
 platform: ruby
 authors:
 - Thomas von Deyen
@@ -13,7 +13,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-19 00:00:00.000000000 Z
+date: 2023-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionmailer
@@ -1305,6 +1305,7 @@ files:
 - db/migrate/20210508091432_create_alchemy_ingredients.rb
 - db/migrate/20220514072456_restrict_on_delete_page_id_foreign_key_from_alchemy_nodes.rb
 - db/migrate/20220622130905_add_playsinline_to_alchemy_essence_videos.rb
+- db/migrate/20230123112425_add_searchable_to_alchemy_pages.rb
 - lib/alchemy.rb
 - lib/alchemy/ability_helper.rb
 - lib/alchemy/admin/locale.rb