Deprecate essence classes

AlchemyCMS · Sep 3, 2022 · b5568f5 · b5568f5
1 parent feb5e6f
commit b5568f5
Show file tree

Hide file tree

Showing 17 changed files with 38 additions and 1 deletion.
diff --git a/app/models/alchemy/content.rb b/app/models/alchemy/content.rb
@@ -19,6 +19,7 @@
 require_dependency "alchemy/content/factory"
 
 module Alchemy
+  # @deprecated
   class Content < BaseRecord
     include Alchemy::Logger
     include Alchemy::Hints

diff --git a/app/models/alchemy/essence_audio.rb b/app/models/alchemy/essence_audio.rb
@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module Alchemy
+  # @deprecated
   class EssenceAudio < ActiveRecord::Base
     acts_as_essence(
       ingredient_column: :attachment,

diff --git a/app/models/alchemy/essence_boolean.rb b/app/models/alchemy/essence_boolean.rb
@@ -13,6 +13,7 @@
 # Stores boolean values.
 # Provides a checkbox in the editor views.
 module Alchemy
+  # @deprecated
   class EssenceBoolean < BaseRecord
     acts_as_essence ingredient_column: "value"
   end

diff --git a/app/models/alchemy/essence_date.rb b/app/models/alchemy/essence_date.rb
@@ -11,6 +11,7 @@
 #
 
 module Alchemy
+  # @deprecated
   class EssenceDate < BaseRecord
     acts_as_essence ingredient_column: "date"
 

diff --git a/app/models/alchemy/essence_file.rb b/app/models/alchemy/essence_file.rb
@@ -14,6 +14,7 @@
 #
 
 module Alchemy
+  # @deprecated
   class EssenceFile < BaseRecord
     belongs_to :attachment, optional: true
     acts_as_essence ingredient_column: "attachment"

diff --git a/app/models/alchemy/essence_headline.rb b/app/models/alchemy/essence_headline.rb
@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module Alchemy
+  # @deprecated
   class EssenceHeadline < BaseRecord
     acts_as_essence
 

diff --git a/app/models/alchemy/essence_html.rb b/app/models/alchemy/essence_html.rb
@@ -11,6 +11,7 @@
 #
 
 module Alchemy
+  # @deprecated
   class EssenceHtml < BaseRecord
     acts_as_essence ingredient_column: "source"
 

diff --git a/app/models/alchemy/essence_link.rb b/app/models/alchemy/essence_link.rb
@@ -14,6 +14,7 @@
 #
 
 module Alchemy
+  # @deprecated
   class EssenceLink < BaseRecord
     acts_as_essence ingredient_column: "link"
   end

diff --git a/app/models/alchemy/essence_node.rb b/app/models/alchemy/essence_node.rb
@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module Alchemy
+  # @deprecated
   class EssenceNode < BaseRecord
     acts_as_essence(
       ingredient_column: :node,

diff --git a/app/models/alchemy/essence_page.rb b/app/models/alchemy/essence_page.rb
@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module Alchemy
+  # @deprecated
   class EssencePage < BaseRecord
     acts_as_essence(
       ingredient_column: :page,

diff --git a/app/models/alchemy/essence_picture.rb b/app/models/alchemy/essence_picture.rb
@@ -22,6 +22,7 @@
 #
 
 module Alchemy
+  # @deprecated
   class EssencePicture < BaseRecord
     include Alchemy::PictureThumbnails
 

diff --git a/app/models/alchemy/essence_picture_view.rb b/app/models/alchemy/essence_picture_view.rb
@@ -2,6 +2,7 @@
 
 module Alchemy
   # Renders an essence picture view
+  # @deprecated
   class EssencePictureView
     include ActionView::Helpers::AssetTagHelper
     include ActionView::Helpers::UrlHelper

diff --git a/app/models/alchemy/essence_richtext.rb b/app/models/alchemy/essence_richtext.rb
@@ -13,6 +13,7 @@
 #
 
 module Alchemy
+  # @deprecated
   class EssenceRichtext < BaseRecord
     acts_as_essence preview_text_column: "stripped_body"
 

diff --git a/app/models/alchemy/essence_select.rb b/app/models/alchemy/essence_select.rb
@@ -12,6 +12,7 @@
 
 # Provides a select box that stores string values.
 module Alchemy
+  # @deprecated
   class EssenceSelect < BaseRecord
     acts_as_essence ingredient_column: "value"
   end

diff --git a/app/models/alchemy/essence_text.rb b/app/models/alchemy/essence_text.rb
@@ -16,6 +16,7 @@
 #
 
 module Alchemy
+  # @deprecated
   class EssenceText < BaseRecord
     acts_as_essence
   end

diff --git a/app/models/alchemy/essence_video.rb b/app/models/alchemy/essence_video.rb
@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module Alchemy
+  # @deprecated
   class EssenceVideo < ActiveRecord::Base
     acts_as_essence(
       ingredient_column: :attachment,

diff --git a/lib/alchemy/essence.rb b/lib/alchemy/essence.rb
@@ -15,6 +15,23 @@ def self.included(base)
     #   * several getters (ie: page, element, content, ingredient, preview_text)
     #
     module ClassMethods
+      DEPRECATED_ESSENCE_CLASSES = %w[
+        Alchemy::EssenceAudio
+        Alchemy::EssenceBoolean
+        Alchemy::EssenceDate
+        Alchemy::EssenceFile
+        Alchemy::EssenceHeadline
+        Alchemy::EssenceHtml
+        Alchemy::EssenceLink
+        Alchemy::EssenceNode
+        Alchemy::EssencePage
+        Alchemy::EssencePicture
+        Alchemy::EssenceRichtext
+        Alchemy::EssenceSelect
+        Alchemy::EssenceText
+        Alchemy::EssenceVideo
+      ]
+
       # Turn any active record model into an essence by calling this class method
       #
       # @option options [String || Symbol] ingredient_column ('body')
@@ -23,8 +40,12 @@ module ClassMethods
       #   The column the the validations run against.
       # @option options [String || Symbol] preview_text_column (ingredient_column)
       #   Specify the column for the preview_text method.
-      #
+      # @deprecated
       def acts_as_essence(options = {})
+        if !DEPRECATED_ESSENCE_CLASSES.include?(name)
+          Alchemy::Deprecation.warn "Please create a custom Alchemy::Ingredient for #{self.name} instead"
+        end
+
         register_as_essence_association!
 
         configuration = {