From f0ed7a0ad1b0dc8674d035ecc530929c09bb56a2 Mon Sep 17 00:00:00 2001
From: Thomas von Deyen <thomas@vondeyen.com>
Date: Thu, 10 Oct 2019 11:17:06 +0200
Subject: [PATCH] Remove local options from essence editors

Passing options as locals to essence editors is not possible anymore.

Static values should be set on the content settings on the contents
defintion in elements.yml instead. For dynamic values please use a
custom essence class.
---
 app/helpers/alchemy/admin/essences_helper.rb  | 32 ++++-----------
 app/helpers/alchemy/elements_block_helper.rb  |  4 +-
 .../alchemy/admin/essence_files/edit.html.erb |  2 +-
 .../essences/_essence_boolean_editor.html.erb |  7 +---
 .../essences/_essence_date_editor.html.erb    |  2 +-
 .../essences/_essence_file_editor.html.erb    | 10 ++---
 .../essences/_essence_picture_editor.html.erb |  5 +--
 .../essences/_essence_select_editor.html.erb  | 13 +++---
 .../essences/_essence_text_editor.html.erb    | 10 ++---
 .../shared/_essence_picture_tools.html.erb    | 17 +++-----
 .../alchemy/essence/templates/editor.html.erb |  1 -
 .../alchemy/elements_block_helper_spec.rb     |  4 +-
 .../essences/essence_boolean_editor_spec.rb   | 30 +++++++++-----
 .../essences/essence_date_editor_spec.rb      | 18 ++++++++
 .../essences/essence_picture_editor_spec.rb   | 11 +++--
 .../essences/essence_select_editor_spec.rb    | 35 ++++++++++++++++
 .../essences/essence_text_editor_spec.rb      | 41 ++++++++++++++-----
 17 files changed, 145 insertions(+), 97 deletions(-)
 create mode 100644 spec/views/essences/essence_date_editor_spec.rb
 create mode 100644 spec/views/essences/essence_select_editor_spec.rb

diff --git a/app/helpers/alchemy/admin/essences_helper.rb b/app/helpers/alchemy/admin/essences_helper.rb
index d67c15c7f6..941c05023a 100644
--- a/app/helpers/alchemy/admin/essences_helper.rb
+++ b/app/helpers/alchemy/admin/essences_helper.rb
@@ -7,22 +7,8 @@ module EssencesHelper
       include Alchemy::Admin::ContentsHelper
 
       # 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
-            Passing options to `render_essence_editor` is deprecated and will be removed from Alchemy 5.0.
-            Add your static `#{options.keys}` options to the `#{content.name}` content definitions `settings` of `#{content.element&.name}` element.
-            For dynamic options consider adding your own essence class.
-          WARN
-        end
-        if !html_options.empty?
-          Alchemy::Deprecation.warn <<~WARN
-            Passing html_options to `render_essence_editor` is deprecated and will be removed in Alchemy 5.0 without replacement.
-          WARN
-        end
-        render_essence(content, :editor, {for_editor: options}, html_options)
+      def render_essence_editor(content)
+        render_essence(content, :editor)
       end
       deprecate :render_essence_editor, deprecator: Alchemy::Deprecation
 
@@ -32,16 +18,16 @@ def render_essence_editor(content, options = {}, html_options = {})
       # 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 = {})
+      #
+      def render_essence_editor_by_name(element, name)
         if element.blank?
           return warning('Element is nil', Alchemy.t(:no_element_given))
         end
         content = element.content_by_name(name)
         if content.nil?
-          render_missing_content(element, name, options)
+          render_missing_content(element, name)
         else
-          render_essence_editor(content, options, html_options)
+          render_essence_editor(content)
         end
       end
       deprecate :render_essence_editor_by_name, deprecator: Alchemy::Deprecation
@@ -68,9 +54,9 @@ 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}
+      #
+      def render_missing_content(element, name)
+        render 'alchemy/admin/contents/missing', {element: element, name: name}
       end
       deprecate :render_missing_content, deprecator: Alchemy::Deprecation
 
diff --git a/app/helpers/alchemy/elements_block_helper.rb b/app/helpers/alchemy/elements_block_helper.rb
index b0df5dde98..eb7636f307 100644
--- a/app/helpers/alchemy/elements_block_helper.rb
+++ b/app/helpers/alchemy/elements_block_helper.rb
@@ -65,8 +65,8 @@ def essence(name)
     # 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)
+      def edit(name)
+        helpers.render_essence_editor_by_name(element, name.to_s)
       end
       deprecate :edit, deprecator: Alchemy::Deprecation
     end
diff --git a/app/views/alchemy/admin/essence_files/edit.html.erb b/app/views/alchemy/admin/essence_files/edit.html.erb
index cd96b70516..25fab7e877 100644
--- a/app/views/alchemy/admin/essence_files/edit.html.erb
+++ b/app/views/alchemy/admin/essence_files/edit.html.erb
@@ -1,4 +1,4 @@
-<% css_classes = @content.settings_value(:css_classes, local_assigns.fetch(:options, {})) %>
+<% css_classes = @content.settings[:css_classes] %>
 
 <%= alchemy_form_for [:admin, @essence_file] do |f| %>
   <%= f.input :link_text %>
diff --git a/app/views/alchemy/essences/_essence_boolean_editor.html.erb b/app/views/alchemy/essences/_essence_boolean_editor.html.erb
index 0c61ffe25a..e767e6c84f 100644
--- a/app/views/alchemy/essences/_essence_boolean_editor.html.erb
+++ b/app/views/alchemy/essences/_essence_boolean_editor.html.erb
@@ -1,11 +1,6 @@
 <div class="content_editor essence_boolean" id="<%= content.dom_id %>" data-content-id="<%= content.id %>">
   <input type="hidden" value="0" name="<%= content.form_field_name %>">
-  <%= check_box_tag content.form_field_name, 1,
-    content.ingredient.presence || content.settings_value(
-      :default_value, local_assigns.fetch(:options, {})
-    ),
-    class: local_assigns.fetch(:html_options, {})[:class],
-    style: local_assigns.fetch(:html_options, {})[:style] %>
+  <%= check_box_tag content.form_field_name, 1, content.ingredient %>
   <label for="<%= content.form_field_id %>" style="display: inline">
     <%= render_content_name(content) %>
   </label>
diff --git a/app/views/alchemy/essences/_essence_date_editor.html.erb b/app/views/alchemy/essences/_essence_date_editor.html.erb
index b32394161f..bb933a3123 100644
--- a/app/views/alchemy/essences/_essence_date_editor.html.erb
+++ b/app/views/alchemy/essences/_essence_date_editor.html.erb
@@ -4,7 +4,7 @@
     content.essence, :date, {
       name: content.form_field_name,
       id: content.form_field_id,
-      value: content.settings_value(:default_value, local_assigns.fetch(:options, {}))
+      value: content.ingredient
     }
   ) %>
   <label for="<%= content.form_field_id %>" class="essence_date--label">
diff --git a/app/views/alchemy/essences/_essence_file_editor.html.erb b/app/views/alchemy/essences/_essence_file_editor.html.erb
index 0232fee6d9..830d583744 100644
--- a/app/views/alchemy/essences/_essence_file_editor.html.erb
+++ b/app/views/alchemy/essences/_essence_file_editor.html.erb
@@ -1,9 +1,8 @@
 <% dialog_link = link_to_dialog render_icon(:file, style: 'regular'),
   alchemy.admin_attachments_path(
     content_id: content.id,
-    only: content.settings_value(:only, local_assigns.fetch(:options, {})),
-    except: content.settings_value(:except, local_assigns.fetch(:options, {})),
-    options: local_assigns.fetch(:options, {})
+    only: content.settings[:only],
+    except: content.settings[:except]
   ),
   {
     title: Alchemy.t(:assign_file),
@@ -30,10 +29,7 @@
     <div class="essence_file_tools">
       <%= dialog_link %>
       <%= link_to_dialog render_icon(:edit),
-        alchemy.edit_admin_essence_file_path(
-          id: content.essence.id,
-          options: local_assigns.fetch(:options, {})
-        ),
+        alchemy.edit_admin_essence_file_path(id: content.essence.id),
         {
           title: Alchemy.t(:edit_file_properties),
           size: '400x215'
diff --git a/app/views/alchemy/essences/_essence_picture_editor.html.erb b/app/views/alchemy/essences/_essence_picture_editor.html.erb
index 5fe44094fe..4175594659 100644
--- a/app/views/alchemy/essences/_essence_picture_editor.html.erb
+++ b/app/views/alchemy/essences/_essence_picture_editor.html.erb
@@ -10,7 +10,7 @@
     <div class="picture_image">
       <div class="thumbnail_background">
         <%- if content.ingredient -%>
-          <%= essence_picture_thumbnail(content, options) %>
+          <%= essence_picture_thumbnail(content) %>
         <% else %>
           <%= render_icon(:image, style: 'regular') %>
         <% end %>
@@ -24,8 +24,7 @@
     <%- end -%>
     <div class="edit_images_bottom">
       <%= render 'alchemy/essences/shared/essence_picture_tools', {
-        content: content,
-        options: options
+        content: content
       } %>
     </div>
   </div>
diff --git a/app/views/alchemy/essences/_essence_select_editor.html.erb b/app/views/alchemy/essences/_essence_select_editor.html.erb
index 0911c477bd..414c3d953c 100644
--- a/app/views/alchemy/essences/_essence_select_editor.html.erb
+++ b/app/views/alchemy/essences/_essence_select_editor.html.erb
@@ -1,21 +1,19 @@
-<% select_values = content.settings_value(:select_values, local_assigns.fetch(:options, {})) %>
-<% inline = content.settings_value(:display_inline, local_assigns.fetch(:options, {})) %>
-<% html_options = local_assigns.fetch(:html_options, {}) %>
+<% select_values = content.settings[:select_values] %>
 
 <%= content_tag :div,
   id: content.dom_id,
   class: [
     "content_editor",
     "essence_select",
-    inline ? 'display_inline' : nil
+    content.settings[:display_inline] ? 'display_inline' : nil
   ].compact, data: {content_id: content.id} do %>
   <%= content_label(content) %>
 
   <% if select_values.nil? %>
     <%= warning(':select_values is nil',
     "<strong>No select values given.</strong>
-    <br>Please provide :<code>select_values</code> either as argument to
-    <code>render_essence_editor</code> helper or as setting on the content definition in
+    <br>Please provide <code>select_values</code> on the
+    content definition <code>settings</code> in
     <code>elements.yml</code>.") %>
   <% else %>
     <%
@@ -25,8 +23,7 @@
       options_tags = options_for_select(select_values, content.ingredient)
     end %>
     <%= select_tag content.form_field_name, options_tags, {
-      class: ["alchemy_selectbox", "essence_editor_select", html_options[:class]].compact,
-      style: html_options[:style]
+      class: ["alchemy_selectbox", "essence_editor_select"]
     } %>
   <% end %>
 <% end %>
diff --git a/app/views/alchemy/essences/_essence_text_editor.html.erb b/app/views/alchemy/essences/_essence_text_editor.html.erb
index f7ec09a272..19d46e53bb 100644
--- a/app/views/alchemy/essences/_essence_text_editor.html.erb
+++ b/app/views/alchemy/essences/_essence_text_editor.html.erb
@@ -1,14 +1,10 @@
-<% options = local_assigns.fetch(:options, {}) %>
-<% html_options = local_assigns.fetch(:html_options, {}) %>
-
-<div class="essence_text content_editor<%= options[:display_inline].to_s == 'true' ? ' display_inline' : '' %>" id="<%= content.dom_id %>">
+<div class="essence_text content_editor<%= content.settings[:display_inline] ? ' display_inline' : '' %>" id="<%= content.dom_id %>">
   <%= content_label(content) %>
   <%= text_field_tag(
     content.form_field_name,
     content.ingredient,
-    class: ["thin_border #{content.settings[:linkable] ? ' text_with_icon' : ''}", html_options[:class]].join(' '),
-    style: html_options[:style],
-    type: content.settings_value(:input_type) || "text"
+    class: "thin_border #{content.settings[:linkable] ? ' text_with_icon' : ''}",
+    type: content.settings[:input_type] || "text"
   ) %>
   <% if content.settings[:linkable] %>
     <%= hidden_field_tag content.form_field_name(:link), content.essence.link %>
diff --git a/app/views/alchemy/essences/shared/_essence_picture_tools.html.erb b/app/views/alchemy/essences/shared/_essence_picture_tools.html.erb
index cb1c874bae..440cc2e968 100644
--- a/app/views/alchemy/essences/shared/_essence_picture_tools.html.erb
+++ b/app/views/alchemy/essences/shared/_essence_picture_tools.html.erb
@@ -1,11 +1,8 @@
-<% linkable = content.settings_value(:linkable, options) != false %>
+<% linkable = content.settings[:linkable] != false %>
 
-<% if content.essence && content.essence.allow_image_cropping?(options) %>
+<% if content.essence && content.essence.allow_image_cropping? %>
   <%= link_to_dialog render_icon(:crop),
-    alchemy.crop_admin_essence_picture_path(
-      content.essence,
-      options: content.settings.update(options)
-    ), {
+    alchemy.crop_admin_essence_picture_path(content.essence), {
       size: "1080x615",
       title: Alchemy.t('Edit Picturemask'),
       image_loader: false,
@@ -19,8 +16,7 @@
   alchemy.admin_pictures_path(
     element_id: content.element,
     content_id: content.id,
-    swap: true,
-    options: options
+    swap: true
   ),
   {
     title: (content.ingredient ? Alchemy.t(:swap_image) : Alchemy.t(:insert_image)),
@@ -51,9 +47,8 @@
 <%= link_to_dialog render_icon(:edit),
   alchemy.edit_admin_essence_picture_path(
     id: content.essence.id,
-    content_id: content.id,
-    options: options
+    content_id: content.id
   ), {
     title: Alchemy.t(:edit_image_properties),
-    size: edit_picture_dialog_size(content, options)
+    size: edit_picture_dialog_size(content)
   }, title: Alchemy.t(:edit_image_properties) %>
diff --git a/lib/rails/generators/alchemy/essence/templates/editor.html.erb b/lib/rails/generators/alchemy/essence/templates/editor.html.erb
index ff4c7973d8..4fe06ba0b1 100644
--- a/lib/rails/generators/alchemy/essence/templates/editor.html.erb
+++ b/lib/rails/generators/alchemy/essence/templates/editor.html.erb
@@ -1,7 +1,6 @@
 <%%#
   Available locals:
   * content (The object the essence is linked to the element)
-  * html_options
 
   Please consult Alchemy::Content.rb docs for further methods on the content object
 %>
diff --git a/spec/helpers/alchemy/elements_block_helper_spec.rb b/spec/helpers/alchemy/elements_block_helper_spec.rb
index 0291d657fd..05474e2cde 100644
--- a/spec/helpers/alchemy/elements_block_helper_spec.rb
+++ b/spec/helpers/alchemy/elements_block_helper_spec.rb
@@ -137,8 +137,8 @@ module Alchemy
 
       describe '#edit' do
         it "should delegate to the render_essence_editor_by_name helper" do
-          expect(scope).to receive(:render_essence_editor_by_name).with(element, "title", foo: 'bar')
-          subject.edit :title, foo: 'bar'
+          expect(scope).to receive(:render_essence_editor_by_name).with(element, "title")
+          subject.edit(:title)
         end
       end
     end
diff --git a/spec/views/essences/essence_boolean_editor_spec.rb b/spec/views/essences/essence_boolean_editor_spec.rb
index b48273742a..c557cb1c2c 100644
--- a/spec/views/essences/essence_boolean_editor_spec.rb
+++ b/spec/views/essences/essence_boolean_editor_spec.rb
@@ -3,28 +3,36 @@
 require 'rails_helper'
 
 describe 'alchemy/essences/_essence_boolean_editor' do
-  let(:essence) { Alchemy::EssenceBoolean.new(ingredient: false) }
-  let(:content) { Alchemy::Content.new(essence: essence, name: 'Boolean') }
+  let(:element) { create(:alchemy_element, name: 'all_you_can_eat') }
+  let(:content) { Alchemy::Content.create(name: 'essence_boolean', type: 'EssenceBoolean', element: element) }
+
+  let(:content_definition) do
+    {
+      name: 'essence_boolean',
+      type: 'EssenceBoolean'
+    }.with_indifferent_access
+  end
 
   before do
+    expect(element).to receive(:content_definition_for) { content_definition }
+    allow_any_instance_of(Alchemy::Content).to receive(:definition) { content_definition }
     allow(view).to receive(:render_content_name).and_return(content.name)
     allow(view).to receive(:render_hint_for).and_return('')
   end
 
-  it "renders a checkbox" do
+  it "renders an unchecked checkbox" do
     render partial: "alchemy/essences/essence_boolean_editor", locals: {content: content}
     expect(rendered).to have_selector('input[type="checkbox"]')
   end
 
-  context 'with default value given in view local options' do
-    it "checks the checkbox" do
-      render partial: "alchemy/essences/essence_boolean_editor", locals: {content: content, options: {default_value: true}}
-      expect(rendered).to have_selector('input[type="checkbox"][checked="checked"]')
-    end
-  end
-
   context 'with default value given in content settings' do
-    before { allow(content).to receive(:settings).and_return({default_value: true}) }
+    let(:content_definition) do
+      {
+        name: 'essence_boolean',
+        type: 'EssenceBoolean',
+        default: true
+      }.with_indifferent_access
+    end
 
     it "checks the checkbox" do
       render partial: "alchemy/essences/essence_boolean_editor", locals: {content: content}
diff --git a/spec/views/essences/essence_date_editor_spec.rb b/spec/views/essences/essence_date_editor_spec.rb
new file mode 100644
index 0000000000..71daea2705
--- /dev/null
+++ b/spec/views/essences/essence_date_editor_spec.rb
@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+RSpec.describe 'alchemy/essences/_essence_date_editor' do
+  let(:content) { Alchemy::Content.new(essence: essence) }
+  let(:essence) { Alchemy::EssenceDate.new }
+
+  before do
+    view.class.send(:include, Alchemy::Admin::BaseHelper)
+    allow(view).to receive(:content_label).and_return(content.name)
+  end
+
+  it "renders a datepicker" do
+    render 'alchemy/essences/essence_date_editor', content: content
+    expect(rendered).to have_css('input[type="text"][data-datepicker-type="date"].date')
+  end
+end
diff --git a/spec/views/essences/essence_picture_editor_spec.rb b/spec/views/essences/essence_picture_editor_spec.rb
index c452563ebf..2ac980fb1f 100644
--- a/spec/views/essences/essence_picture_editor_spec.rb
+++ b/spec/views/essences/essence_picture_editor_spec.rb
@@ -22,7 +22,7 @@
     )
   end
 
-  let(:options) { Hash.new }
+  let(:settings) { Hash.new }
 
   before do
     view.class.send(:include, Alchemy::Admin::BaseHelper)
@@ -32,8 +32,9 @@
   end
 
   subject do
+    allow(content).to receive(:settings) { settings }
     render partial: "alchemy/essences/essence_picture_editor",
-      locals: {content: content, options: options}
+      locals: {content: content}
     rendered
   end
 
@@ -45,8 +46,10 @@
   end
 
   context "with settings[:deletable] being false" do
-    let(:options) do
-      {linkable: false}
+    let(:settings) do
+      {
+        linkable: false
+      }
     end
 
     it 'should not render a button to link and unlink the picture' do
diff --git a/spec/views/essences/essence_select_editor_spec.rb b/spec/views/essences/essence_select_editor_spec.rb
new file mode 100644
index 0000000000..8043ecc693
--- /dev/null
+++ b/spec/views/essences/essence_select_editor_spec.rb
@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'rails_helper'
+
+RSpec.describe 'alchemy/essences/_essence_select_editor' do
+  let(:content) { Alchemy::Content.new(essence: essence) }
+  let(:essence) { Alchemy::EssenceSelect.new }
+
+  before do
+    view.class.send(:include, Alchemy::Admin::BaseHelper)
+    allow(view).to receive(:content_label).and_return(content.name)
+  end
+
+  context 'if no select values are set' do
+    it 'renders a warning' do
+      render 'alchemy/essences/essence_select_editor', content: content
+      expect(rendered).to have_css('.warning')
+    end
+  end
+
+  context 'if select values are set' do
+    before do
+      allow(content).to receive(:settings) do
+        {
+          select_values: %w(red blue yellow)
+        }
+      end
+    end
+
+    it "renders a select box" do
+      render 'alchemy/essences/essence_select_editor', content: content
+      expect(rendered).to have_css('select.alchemy_selectbox')
+    end
+  end
+end
diff --git a/spec/views/essences/essence_text_editor_spec.rb b/spec/views/essences/essence_text_editor_spec.rb
index 9cb51987c9..bf10bab972 100644
--- a/spec/views/essences/essence_text_editor_spec.rb
+++ b/spec/views/essences/essence_text_editor_spec.rb
@@ -5,28 +5,49 @@
 describe 'alchemy/essences/_essence_text_editor' do
   let(:essence) { Alchemy::EssenceText.new(body: '1234') }
   let(:content) { Alchemy::Content.new(essence: essence) }
+  let(:settings) { {} }
 
-  context 'with no input type set' do
-    before do
-      allow(view).to receive(:content_label).and_return("1e Zahl")
-      allow(content).to receive(:settings).and_return({})
-    end
+  subject do
+    render partial: "alchemy/essences/essence_text_editor", locals: { content: content }
+  end
 
+  before do
+    view.class.send :include, Alchemy::Admin::BaseHelper
+    allow(view).to receive(:content_label).and_return("1e Zahl")
+    allow(content).to receive(:settings) { settings }
+    subject
+  end
+
+  context 'with no input type set' do
     it "renders an input field of type number" do
-      render partial: "alchemy/essences/essence_text_editor", locals: {content: content, options: {}, html_options: {}}
       expect(rendered).to have_selector('input[type="text"]')
     end
   end
 
   context 'with a different input type set' do
-    before do
-      allow(view).to receive(:content_label).and_return("1e Zahl")
-      allow(content).to receive(:settings).and_return({input_type: "number"})
+    let(:settings) do
+      {
+        input_type: "number"
+      }
     end
 
     it "renders an input field of type number" do
-      render partial: "alchemy/essences/essence_text_editor", locals: {content: content, options: {}, html_options: {}}
       expect(rendered).to have_selector('input[type="number"]')
     end
   end
+
+  context 'with settings linkable set to true' do
+    let(:settings) do
+      {
+        linkable: true
+      }
+    end
+
+    it "renders link buttons" do
+      expect(rendered).to have_selector('input[type="hidden"][name="contents[][link]"]')
+      expect(rendered).to have_selector('input[type="hidden"][name="contents[][link_title]"]')
+      expect(rendered).to have_selector('input[type="hidden"][name="contents[][link_class_name]"]')
+      expect(rendered).to have_selector('input[type="hidden"][name="contents[][link_target]"]')
+    end
+  end
 end