Merge pull request #1643 from tvdeyen/deprecate-element-editors

Deprecate element editors

app/helpers/alchemy/admin/elements_helper.rb

@@ -48,12 +48,18 @@ module ElementsHelper
       # @note If the partial is not found
       #   <tt>alchemy/elements/_editor_not_found.html.erb</tt> gets rendered.
       #
+      # @deprecated Using element editor partials is deprecated and will be removed in Alchemy 5.0
       def render_editor(element)
         if element.nil?
           warning('Element is nil')
           render "alchemy/elements/editor_not_found", {name: 'nil'}
           return
         end
+        Alchemy::Deprecation.warn <<~WARN
+          Using element editor partials is deprecated and will be removed in Alchemy 5.0.
+          You can delete the `app/views/alchemy/elements/_#{element.name}_editor` partial
+          and Alchemy will render the content editors for you.
+        WARN
 
         render "alchemy/elements/#{element.name}_editor", element: element
       rescue ActionView::MissingTemplate => e

app/helpers/alchemy/admin/essences_helper.rb

@@ -8,6 +8,7 @@ module EssencesHelper
 
       # Renders the Content editor partial from the given Content.
       # For options see -> render_essence
+      # @deprecated
       def render_essence_editor(content, options = {}, html_options = {})
         if !options.empty?
           Alchemy::Deprecation.warn <<~WARN
@@ -23,14 +24,15 @@ def render_essence_editor(content, options = {}, html_options = {})
         end
         render_essence(content, :editor, {for_editor: options}, html_options)
       end
+      deprecate :render_essence_editor, deprecator: Alchemy::Deprecation
 
       # Renders the Content editor partial found in views/contents/ for the content with name inside the passed Element.
       # For options see -> render_essence
       #
       # Content creation on the fly:
       #
       # If you update the elements.yml file after creating an element this helper displays a error message with an option to create the content.
-      #
+      # @deprecated
       def render_essence_editor_by_name(element, name, options = {}, html_options = {})
         if element.blank?
           return warning('Element is nil', Alchemy.t(:no_element_given))
@@ -42,6 +44,7 @@ def render_essence_editor_by_name(element, name, options = {}, html_options = {}
           render_essence_editor(content, options, html_options)
         end
       end
+      deprecate :render_essence_editor_by_name, deprecator: Alchemy::Deprecation
 
       # Returns all public pages from current language as an option tags string suitable or the Rails +select_tag+ helper.
       #
@@ -65,10 +68,11 @@ def pages_for_select(pages = nil, selected = nil, prompt = "Choose page", page_a
       end
 
       # Renders the missing content partial
-      #
+      # @deprecated
       def render_missing_content(element, name, options)
         render 'alchemy/admin/contents/missing', {element: element, name: name, options: options}
       end
+      deprecate :render_missing_content, deprecator: Alchemy::Deprecation
 
       # Renders a thumbnail for given EssencePicture content with correct cropping and size
       def essence_picture_thumbnail(content, options = {})

app/helpers/alchemy/elements_block_helper.rb

@@ -56,11 +56,12 @@ def essence(name)
     end
 
     # Block-level helper class for element editors.
-    #
+    # @deprecated
     class ElementEditorHelper < BlockHelper
       def edit(name, *args)
         helpers.render_essence_editor_by_name(element, name.to_s, *args)
       end
+      deprecate :edit, deprecator: Alchemy::Deprecation
     end
 
     # Block-level helper for element views. Constructs a DOM element wrapping

app/views/alchemy/admin/elements/_element.html.erb

@@ -22,7 +22,15 @@
         <% element.definition[:warning].tap do |warning| %>
           <%= render_message(:warning, sanitize(warning)) if warning %>
         <% end %>
-        <%== render_editor(element) %>
+        <% if lookup_context.exists?("#{element.name}_editor", ["alchemy/elements"], true) %>
+          <%= render_editor(element) %>
+        <% else %>
+          <%= element_editor_for(element) do %>
+            <% element.contents.each do |content| %>
+              <%= render_essence(content, :editor) %>
+            <% end %>
+          <% end %>
+        <% end %>
       </div>
 
       <% if element.taggable? %>

lib/rails/generators/alchemy/elements/elements_generator.rb

@@ -19,7 +19,6 @@ def create_partials
             raise "Element name '#{element['name']}' has wrong format. Only lowercase and non whitespace characters allowed."
           end
 
-          conditional_template "editor.html.#{template_engine}", "#{elements_dir}/_#{@element_name}_editor.html.#{template_engine}"
           conditional_template "view.html.#{template_engine}", "#{elements_dir}/_#{@element_name}_view.html.#{template_engine}"
         end
       end

spec/helpers/alchemy/admin/elements_helper_spec.rb

@@ -22,7 +22,9 @@ module Alchemy
         end
 
         it "renders the element's editor partial" do
-          is_expected.to have_selector('div.content_editor > label', text: 'Headline')
+          element_editor_partial_name = "alchemy/elements/#{element.name}_editor"
+          expect(helper).to receive(:render).with(element_editor_partial_name, element: element) { '' }
+          subject
         end
 
         context 'with element editor partial not found' do