alchemy_cms 2.9.1 → 3.0.0.rc5

data/app/helpers/alchemy/admin/attachments_helper.rb

@@ -1,6 +1,7 @@
 module Alchemy
   module Admin
     module AttachmentsHelper
+      include Alchemy::Admin::BaseHelper
 
       def mime_to_human(mime)
         I18n.t(mime, scope: 'mime_types', default: _t(:document))

data/app/helpers/alchemy/admin/base_helper.rb

@@ -1,73 +1,48 @@
 module Alchemy
   module Admin
 
-    # This module contains helper methods for rendering overlay windows, toolbar buttons and confirmation windows.
+    # This module contains helper methods for rendering dialogs, toolbar buttons and confirmation windows.
     #
     # The most important helpers for module developers are:
     #
     # * {#toolbar}
     # * {#toolbar_button}
-    # * {#link_to_overlay_window}
-    # * {#link_to_confirmation_window}
+    # * {#link_to_dialog}
+    # * {#link_to_confirm_dialog}
     #
     module BaseHelper
       include Alchemy::BaseHelper
       include Alchemy::Admin::NavigationHelper
 
-      # This helper renders the link to an overlay window.
+      # This helper renders the link to an dialog.
       #
-      # We use this for our fancy modal overlay windows in the Alchemy cockpit.
+      # We use this for our fancy modal dialogs in the Alchemy cockpit.
       #
       # == Example
       #
-      #   <%= link_to_overlay_window('Edit', edit_product_path, {size: '200x300'}, {class: 'icon_button'}) %>
+      #   <%= link_to_dialog('Edit', edit_product_path, {size: '200x300'}, {class: 'icon_button'}) %>
       #
       # @param [String] content
       #   The string inside the link tag
       # @param [String or Hash] url
-      #   The url of the action displayed inside the overlay window.
+      #   The url of the action displayed inside the dialog.
       # @param [Hash] options
-      #   options for the overlay window.
+      #   options for the dialog.
       # @param [Hash] html_options
       #   HTML options passed to the <tt>link_to</tt> helper
       #
       # @option options [String] :size
       #    String with format of "WidthxHeight". I.E. ("420x280")
       # @option options [String] :title
-      #    Text for the overlay title bar.
-      # @option options [Boolean] :overflow (false)
-      #    Should the dialog have overlapping content. If not, it shows scrollbars. Good for select boxes.
-      # @option options [Boolean] :resizable (false)
-      #    Is the dialog window resizable?
+      #    Text for the dialog title bar.
       # @option options [Boolean] :modal (true)
       #    Show as modal window.
-      # @option options [Boolean] :overflow (true)
-      #    Should the window show overflowing content?
-      #
-      def link_to_overlay_window(content, url, options={}, html_options={})
-        ActiveSupport::Deprecation.warn("Used deprecated link_to_overlay_window helper. It will be removed in Alchemy v3.0. Please use link_to_dialog instead.")
-        default_options = {
-          :modal => true,
-          :overflow => true,
-          :resizable => false
-        }
+      #
+      def link_to_dialog(content, url, options={}, html_options={})
+        default_options = {modal: true}
         options = default_options.merge(options)
-        size = options.delete(:size).to_s.split('x')
-        link_to(content, url,
-          html_options.merge(
-            'data-alchemy-overlay' => options.update(
-              :width => size && size[0] ? size[0] : 'auto',
-              :height => size && size[1] ? size[1] : 'auto',
-            ).to_json
-          )
-        )
-      end
-
-      # Used for language selector in Alchemy cockpit sitemap. So the user can select the language branche of the page.
-      def language_codes_for_select
-        configuration(:languages).collect { |language|
-          language[:language_code]
-        }
+        link_to content, url,
+          html_options.merge('data-alchemy-dialog' => options.to_json)
       end
 
       # Used for translations selector in Alchemy cockpit user settings.
@@ -109,7 +84,7 @@ module Alchemy
         }.merge(options)
         content_tag(:div, class: 'js_filter_field_box') do
           concat text_field_tag(nil, nil, options)
-          concat content_tag('span', '', class: 'icon search')
+          concat render_icon(:search)
           concat link_to('', '', class: 'js_filter_field_clear', title: _t(:click_to_show_all))
           concat content_tag(:label, _t(:search), for: options[:id])
         end
@@ -119,41 +94,40 @@ module Alchemy
       #
       # === Example:
       #
-      #   <%= link_to_confirmation_window('delete', 'Do you really want to delete this comment?', '/admin/comments/1') %>
+      #   <%= link_to_confirm_dialog('delete', 'Do you really want to delete this comment?', '/admin/comments/1') %>
       #
       # @param [String] link_string
       #   The content inside the <a> tag
       # @param [String] message
-      #   The message that is displayed in the overlay window
+      #   The message that is displayed in the dialog
       # @param [String] url
       #   The url that gets opened after confirmation (Note: This is an Ajax request with a method of DELETE!)
       # @param [Hash] html_options
       #   HTML options get passed to the link
       #
       # @option html_options [String] :title (_t(:please_confirm))
-      #   The overlay title
+      #   The dialog title
       # @option html_options [String] :message (message)
-      #   The message displayed in the overlay
+      #   The message displayed in the dialog
       # @option html_options [String] :ok_label (_t("Yes"))
       #   The label for the ok button
       # @option html_options [String] :cancel_label (_t("No"))
       #   The label for the cancel button
       #
-      def link_to_confirmation_window(link_string = "", message = "", url = "", html_options = {})
-        ActiveSupport::Deprecation.warn("Used deprecated link_to_confirmation_window helper. It will be removed in Alchemy v3.0. Please use link_to_confirm_dialog instead.")
+      def link_to_confirm_dialog(link_string = "", message = "", url = "", html_options = {})
         link_to(link_string, url,
           html_options.merge(
             'data-alchemy-confirm-delete' => {
-              :title => _t(:please_confirm),
-              :message => message,
-              :ok_label => _t("Yes"),
-              :cancel_label => _t("No")
+              title: _t(:please_confirm),
+              message: message,
+              ok_label: _t("Yes"),
+              cancel_label: _t("No")
             }.to_json
           )
         )
       end
 
-      # Returns a form and a button that opens a modal confirm window.
+      # Returns a form and a button that opens a modal confirm dialog.
       #
       # After confirmation it proceeds to send the form's action.
       #
@@ -166,7 +140,7 @@ module Alchemy
       # @param [String] url
       #   The url that gets opened after confirmation
       # @param [Hash] options
-      #   Options for the Alchemy confirm overlay (see also +app/assets/javascripts/alchemy/alchemy.window.js#openConfirmWindow+)
+      #   Options for the Alchemy confirm dialog (see also +app/assets/javascripts/alchemy/alchemy.confirm_dialog.js.coffee+)
       # @param [Hash] html_options
       #   HTML options that get passed to the +button_tag+ helper.
       #
@@ -179,11 +153,38 @@ module Alchemy
           title: _t(:please_confirm),
           cancel_label: _t("No")
         }.merge(options)
-        form_tag url, {method: html_options.delete(:method)} do
+        form_tag url, {method: html_options.delete(:method), class: 'button-with-confirm'} do
           button_tag value, html_options.merge('data-alchemy-confirm' => options.to_json)
         end
       end
 
+      # A delete button with confirmation window.
+      #
+      # @option title [String]
+      #   The title for the confirm dialog
+      # @option message [String]
+      #   The message for the confirm dialog
+      # @option icon [String]
+      #   The icon class for the button
+      #
+      def delete_button(url, options = {}, html_options = {})
+        options = {
+          title: _t('Delete'),
+          message: _t('Are you sure?'),
+          icon: 'destroy'
+        }.merge(options)
+        button_with_confirm(
+          render_icon(options[:icon]),
+          url, {
+            message: options[:message]
+          }, {
+            method: 'delete',
+            title: options[:title],
+            class: "icon_only #{html_options.delete(:class)}".strip
+          }.merge(html_options)
+        )
+      end
+
       # (internal) Renders translated Module Names for html title element.
       def render_alchemy_title
         if content_for?(:title)
@@ -201,22 +202,6 @@ module Alchemy
         image_count.blank? ? nil : image_count.to_i
       end
 
-      # (internal) Renders a select tag for all items in the clipboard
-      def clipboard_select_tag(items, html_options = {})
-        options = [[_t('Please choose'), ""]]
-        items.each do |item|
-          options << [item.class.to_s == 'Alchemy::Element' ? item.display_name_with_preview_text : item.name, item.id]
-        end
-        select_tag(
-          'paste_from_clipboard',
-          !@page.new_record? && @page.can_have_cells? ? grouped_elements_for_select(items, :id) : options_for_select(options),
-          {
-            :class => [html_options[:class], 'alchemy_selectbox'].join(' '),
-            :style => html_options[:style]
-          }
-        )
-      end
-
       # Renders a toolbar button for the Alchemy toolbar
       #
       # == Example
@@ -226,12 +211,12 @@ module Alchemy
       #     label: 'Create',
       #     url: new_resource_path,
       #     title: 'Create Resource',
-      #     hotkey: 'alt-n',
-      #     overlay_options: {
+      #     hotkey: 'alt+n',
+      #     dialog_options: {
       #       title: 'Create Resource',
       #       size: "430x400"
       #     },
-      #     if_permitted_to: [:new, resource_permission_scope]
+      #     if_permitted_to: [:create, resource_model]
       #   ) %>
       #
       # @option options [String] :icon
@@ -244,31 +229,31 @@ module Alchemy
       #   Text for title tag.
       # @option options [String] :hotkey
       #   Keyboard shortcut for this button. I.E +alt-n+
-      # @option options [Boolean] :overlay (true)
-      #   Open the link in a modal overlay window.
-      # @option options [Hash] :overlay_options
-      #   Overlay options. See link_to_overlay_window helper.
+      # @option options [Boolean] :dialog (true)
+      #   Open the link in a modal dialog.
+      # @option options [Hash] :dialog_options
+      #   Overlay options. See link_to_dialog helper.
       # @option options [Array] :if_permitted_to ([:action, :controller])
       #   Check permission for button. Exactly how you defined the permission in your +authorization_rules.rb+. Defaults to controller and action from button url.
       # @option options [Boolean] :skip_permission_check (false)
       #   Skip the permission check. NOT RECOMMENDED!
       # @option options [Boolean] :loading_indicator (true)
-      #   Shows the please wait overlay while loading. Only for buttons not opening an overlay window.
+      #   Shows the please wait dialog while loading. Only for buttons not opening an dialog.
       #
       def toolbar_button(options = {})
         options = {
-          overlay: true,
+          dialog: true,
           skip_permission_check: false,
           active: false,
           link_options: {},
-          overlay_options: {},
+          dialog_options: {},
           loading_indicator: true
         }.merge(options.symbolize_keys)
         button = render(
           'alchemy/admin/partials/toolbar_button',
           options: options
         )
-        if options[:skip_permission_check] || permitted_to?(*permission_from_options(options))
+        if options[:skip_permission_check] || can?(*permission_from_options(options))
           button
         else
           ""
@@ -287,12 +272,12 @@ module Alchemy
       #         label: label_title,
       #         url: new_resource_path,
       #         title: label_title,
-      #         hotkey: 'alt-n',
-      #         overlay_options: {
+      #         hotkey: 'alt+n',
+      #         dialog_options: {
       #           title: label_title,
       #           size: "430x400"
       #         },
-      #         if_permitted_to: [:new, resource_permission_scope]
+      #         if_permitted_to: [:create, resource_model]
       #       }
       #     ]
       #   ) %>
@@ -372,11 +357,19 @@ module Alchemy
       #   The value the input displays
       #
       def alchemy_datepicker(object, method, html_options={})
-        text_field(object.class.name.underscore.to_sym, method.to_sym, {
-          :type => 'date',
-          :class => 'thin_border date',
-          :value => object.send(method.to_sym).nil? ? nil : l(object.send(method.to_sym), :format => :datepicker)
-        }.merge(html_options))
+        value = nil
+        if object.send(method.to_sym).present?
+          value = l(object.send(method.to_sym), format: :datepicker)
+        elsif html_options[:value].present?
+          date = html_options.delete(:value)
+          date = Time.parse(date) if date.is_a?(String)
+          value = l(date, format: :datepicker)
+        end
+        text_field object.class.name.underscore.to_sym, method.to_sym, html_options.merge({
+          type: 'date',
+          class: 'date',
+          value: value
+        })
       end
 
       # Merges the params-hash with the given hash
@@ -419,7 +412,19 @@ module Alchemy
         "#{controller_name} #{action_name}"
       end
 
-    private
+      # (internal) Returns options for the clipboard select tag
+      def clipboard_select_tag_options(items)
+        if @page.persisted? && @page.can_have_cells?
+          grouped_options_for_select(grouped_elements_for_select(items, :id))
+        else
+          options = items.map do |item|
+            [item.respond_to?(:display_name_with_preview_text) ? item.display_name_with_preview_text : item.name, item.id]
+          end
+          options_for_select(options)
+        end
+      end
+
+      private
 
       def permission_from_options(options)
         if options[:if_permitted_to].blank?
@@ -430,7 +435,7 @@ module Alchemy
       end
 
       def permission_array_from_url(options)
-        action_controller = options[:url].gsub(/^\//, '').split('/')
+        action_controller = options[:url].gsub(/\A\//, '').split('/')
         [
           action_controller.last.to_sym,
           action_controller[0..action_controller.length-2].join('_').to_sym

data/app/helpers/alchemy/admin/contents_helper.rb

@@ -3,23 +3,16 @@ module Alchemy
     module ContentsHelper
       include Alchemy::Admin::BaseHelper
 
-      # Returns a string for the id attribute of a html element for the given content
-      def content_dom_id(content)
-        return "" if content.nil?
-        if content.class == String
-          c = Content.find_by_name(content)
-          return "" if c.nil?
-        else
-          c = content
-        end
-        "#{c.essence_type.demodulize.underscore}_#{c.id}"
-      end
-
-      # Renders the name of elements content or the default name defined in elements.yml
+      # Renders the name of elements content.
+      #
+      # Displays a warning icon if content is missing its description.
+      #
+      # Displays a mandatory field indicator, if the content has validations.
+      #
       def render_content_name(content)
         if content.blank?
-          warning('Element is nil')
-          return ""
+          warning('Content is nil')
+          return
         else
           content_name = content.name_for_label
         end
@@ -28,25 +21,29 @@ module Alchemy
           title = _t(:content_description_missing)
           content_name = %(<span class="warning icon" title="#{title}"></span>&nbsp;#{content_name}).html_safe
         end
-        content.has_validations? ? "#{content_name}<span class='validation_indicator'>*</span>".html_safe : content_name
+        if content.has_validations?
+          "#{content_name}<span class='validation_indicator'>*</span>".html_safe
+        else
+          content_name
+        end
       end
 
       # Renders a link to show the new content overlay that lets you add additional contents.
       #
-      # See +render_create_content_link+ helper for exmaples on how to define additional contents.
+      # See +render_create_content_link+ helper for examples on how to define additional contents.
       #
       def render_new_content_link(element)
-        link_to_overlay_window(
-          render_icon(:create) + _t('add new content'),
+        link_to_dialog(
+          "#{render_icon(:create)} #{_t('add new content')}".html_safe,
           alchemy.new_admin_element_content_path(element),
           {
-            :size => '310x115',
-            :title => _t('Select an content'),
-            :overflow => true
+            size: '310x115',
+            title: _t('Select an content'),
+            overflow: true
           },
           {
-            :id => "add_content_for_element_#{element.id}",
-            :class => 'button with_icon new_content_link'
+            id: "add_content_for_element_#{element.id}",
+            class: 'button with_icon new_content_link'
           }
         )
       end
@@ -72,35 +69,35 @@ module Alchemy
       #
       # Optionally you can pass a label:
       #
-      #   <%= render_create_content_link(element, 'file', :label => 'Add a file') %>
+      #   <%= render_create_content_link(element, 'file', label: 'Add a file') %>
       #
       def render_create_content_link(element, content_name, options = {}, options_for_content = {})
         defaults = {
-          :label => _t('Add %{name}', :name => _t(content_name, :scope => :content_names))
+          label: _t('Add %{name}', name: _t(content_name, scope: :content_names))
         }
         options = defaults.merge(options)
         link_to(render_icon(:create) + options[:label], alchemy.admin_contents_path(
-            :content => {
-              :name => content_name,
-              :element_id => element.id
+            content: {
+              name: content_name,
+              element_id: element.id
             },
-            :options => options_for_content.to_json
+            options: options_for_content.to_json
           ),
-          :method => :post,
-          :remote => true,
-          :id => "add_content_for_element_#{element.id}",
-          :class => 'button with_icon new_content_link'
+          method: :post,
+          remote: true,
+          id: "add_content_for_element_#{element.id}",
+          class: 'button with_icon new_content_link'
         )
       end
 
       # Renders a link for removing that content
       def delete_content_link(content)
-        link_to_confirmation_window(
+        link_to_confirm_dialog(
           render_icon('delete-small'),
           _t('Do you really want to delete this content?'),
           alchemy.admin_content_path(content),
-          :class => 'icon_button small',
-          :title => _t('Remove this content')
+          class: 'icon_button small',
+          title: _t('Remove this content')
         ) if content.settings[:deletable]
       end