refinerycms-images 4.0.3 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ace9c6f436bf1a41d2025a7930a950eb0e6b68b2726498b6dce7abcfe033e5a4
-  data.tar.gz: d42c450cd1c5c3abd85fce72743e571e129868625070e9413431a040820469bd
+  metadata.gz: 9843f043fac07905d1893351f1f570530acb3e5864bfb33340f8a8144cf83d4f
+  data.tar.gz: 10dbda158cc2298e77cf3b5340a32a0b238093dec5b4be4a493576caf2d022e4
 SHA512:
-  metadata.gz: 706080c62145f80e477671d3f6ca6b6d6e1c689214f4eea2b8143444b9da5532d005d5f6f0c5921a3f116ff2fded37d6f19d900de2fbc779ea75a73286123da7
-  data.tar.gz: 93243ec3b8edf6f3a265108e5a404fa2eb83113171246cbcfba3d5c97f2452f88569f21f91189d125399116b3e485a3db1a7985b8e0d580ac4f7811259e01483
+  metadata.gz: baf1f003fc65d7deb38c1ce79b2559d8b6955aa9755fe7f87360bad8a7dfea512bb9dc286ff1aaaba8732b2c7af11c59da902787292fb9259bb9163c723dadc4
+  data.tar.gz: d0ca50f9d0333d4dd8fb22d43294e948f660cc40d00114d4d995478d7d195390d50e907da36cc2d3d8870a5c2cb2348833d41ac9724ac373922daeb3a0f7fe34

data/app/controllers/refinery/admin/images_controller.rb

@@ -1,11 +1,17 @@
+# frozen_string_literal: true
+
+require 'will_paginate/array'
+
 module Refinery
   module Admin
     class ImagesController < ::Refinery::AdminController
 
       crudify :'refinery/image',
-              include: [:translations],
+              include: [:translations, :crops],
               order: "updated_at DESC",
-              sortable: false
+              sortable: false,
+              conditions: 'parent_id IS NULL',
+              find_actions: [:update, :destroy, :edit]
 
       before_action :change_list_mode_if_specified, :init_dialog
 
@@ -18,7 +24,6 @@ module Refinery
       # This renders the image insert dialog
       def insert
         self.new if @image.nil?
-
         @url_override = refinery.admin_images_path(request.query_parameters.merge(insert: true))
 
         if params[:conditions].present?
@@ -42,8 +47,10 @@ module Refinery
         begin
           if params[:image].present? && params[:image][:image].is_a?(Array)
             params[:image][:image].each do |image|
-              params[:image][:image_title] = params[:image][:image_title].presence || auto_title(image.original_filename)
-              @images << (@image = ::Refinery::Image.create({image: image}.merge(image_params.except(:image).to_h)))
+              image_title = params[:image][:image_title].presence || auto_title(image.original_filename)
+              @images << @image = ::Refinery::Image.create(
+                image_params.merge(image_title: image_title, image: image)
+              )
             end
           else
             @images << (@image = ::Refinery::Image.create(image_params))
@@ -91,7 +98,7 @@ module Refinery
               if request.xhr?
                 render partial: '/refinery/message'
               else
-                redirect_to :back
+                redirect_back(fallback_location: { action: 'edit' })
               end
             else
               redirect_back_or_default refinery.admin_images_path
@@ -110,6 +117,39 @@ module Refinery
         end
       end
 
+      def crop
+        parent_image = ::Refinery::Image.find_by_id(params[:image_id])
+
+        cropped_image = ::Refinery::Image.new(
+          parent_id: parent_image.id,
+          image: params[:image]
+        )
+
+        if cropped_image.valid? && cropped_image.save!
+          flash.notice = ::I18n.t('refinery.admin.images.form.crop_success')
+          render json: {
+            message: ::I18n.t('refinery.admin.images.form.crop_success'),
+            crop: render_to_string('/refinery/admin/images/_crop', layout: false, locals: { crop: cropped_image})
+          }
+        else
+          flash.now[:error] = ::I18n.t('refinery.admin.images.form.crop_error')
+          render json: { message: ::I18n.t('refinery.admin.images.form.crop_error') }
+        end
+      end
+
+      def destroy_crop
+        @image = Refinery::Image.find_by_id(params[:image_id])
+        title = @image.parent.image_name
+
+        if @image.destroy
+          flash.notice = t('destroyed', scope: 'refinery.crudify', what: title)
+
+          respond_to do |format|
+            format.js { render "/refinery/admin/images/destroy_crop", locals: { image_id: @image.id } }
+          end
+        end
+      end
+
       protected
 
       def init_dialog
@@ -130,7 +170,7 @@ module Refinery
       end
 
       def paginate_images
-        @images = @images.paginate(page: params[:page], per_page: Image.per_page(from_dialog?, !@app_dialog))
+        @images = @images.root.paginate(page: params[:page], per_page: Image.per_page(from_dialog?, !@app_dialog))
       end
 
       def restrict_controller
@@ -149,10 +189,9 @@ module Refinery
 
       def permitted_image_params
         [
-          :image, :image_size, :image_title, :image_alt
+          { image: [] }, :image_size, :image_title, :image_alt
         ]
       end
-
     end
   end
 end

data/app/helpers/refinery/admin/images_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Refinery
   module Admin
     module ImagesHelper
@@ -7,17 +9,21 @@ module Refinery
         end
       end
 
+      def locale_text_icon(text)
+        text
+      end
+
       def thumbnail_urls(image)
-        thumbnail_urls = {
-          :"data-original" => image_path(image.url),
-          :"data-grid" => image_path(image.thumbnail(:geometry => '135x135#c').url)
+        thumbnails = {
+          original: image_path(image.url),
+          grid: image_path(image.thumbnail(geometry: '135x135#c').url)
         }
 
-        Refinery::Images.user_image_sizes.sort_by{ |key, geometry| geometry}.each do |size, pixels|
-          thumbnail_urls[:"data-#{size.to_s.parameterize}"] = image_path(image.thumbnail(:geometry => pixels).url)
+        Refinery::Images.user_image_sizes.sort_by { |key, geometry| geometry }.each do |size, pixels|
+          thumbnails[size.to_s.parameterize] = image_path(image.thumbnail(geometry: pixels).url)
         end
 
-        thumbnail_urls
+        { data: thumbnails }
       end
     end
   end

data/app/models/refinery/image.rb

@@ -2,24 +2,32 @@ require 'dragonfly'
 
 module Refinery
   class Image < Refinery::Core::BaseModel
+    extend Mobility
     translates :image_title, :image_alt
 
-    attribute :image_title
-    attribute :image_alt
-
-    dragonfly_accessor :image, :app => :refinery_images
+    dragonfly_accessor :image, app: :refinery_images
 
     include Images::Validators
 
-    validates :image, :presence  => true
+    validates :image, presence: true
     validates_with ImageSizeValidator
-    validates_with ImageUpdateValidator, :on => :update
+    validates_with ImageUpdateValidator, on: :update
     validates_property :mime_type,
-                       :of => :image,
-                       :in => ::Refinery::Images.whitelisted_mime_types,
-                       :message => :incorrect_format
+                       of: :image,
+                       in: ::Refinery::Images.allowed_mime_types,
+                       message: ->(mime_type, image){
+                         ::I18n.t(:incorrect_format,
+                                  scope: 'activerecord.errors.models.refinery/image',
+                                  actual: mime_type,
+                                  valid_types: ::Refinery::Images.allowed_mime_types_msg)
+                       }
+
+    delegate :size, :mime_type, :url, :width, :height, to: :image
+
+    has_many :crops, class_name: '::Refinery::Image', foreign_key: 'parent_id', dependent: :destroy
+    belongs_to :parent, class_name: '::Refinery::Image', foreign_key: 'parent_id', optional: true
 
-    delegate :size, :mime_type, :url, :width, :height, :to => :image
+    scope :root, -> { where(parent_id: nil) }
 
     class << self
       # How many images per page should be displayed?
@@ -38,7 +46,7 @@ module Refinery
 
     # Get a thumbnail job object given a geometry and whether to strip image profiles and comments.
     def thumbnail(options = {})
-      options = { :geometry => nil, :strip => false }.merge(options)
+      options = { geometry: nil, strip: false }.merge(options)
       geometry = convert_to_geometry(options[:geometry])
       thumbnail = image
       thumbnail = thumbnail.thumb(geometry) if geometry
@@ -49,7 +57,7 @@ module Refinery
     # Intelligently works out dimensions for a thumbnail of this image based on the Dragonfly geometry string.
     def thumbnail_dimensions(geometry)
       dimensions = ThumbnailDimensions.new(geometry, image.width, image.height)
-      { :width => dimensions.width, :height => dimensions.height }
+      { width: dimensions.width, height: dimensions.height }
     end
 
     # Returns a titleized version of the filename

data/app/presenters/refinery/admin/grid_presenter.rb

@@ -0,0 +1,42 @@
+module Refinery
+  module Admin
+
+    # Refinery::Admin::GridPresenter is a class intended for presenting
+    # grouped records in a grid format within the Refinery CMS admin interface.
+    #
+    # It inherits from Refinery::Admin::GroupPresenter and overrides specific
+    # properties to provide custom behavior suitable for grid presentations.
+    #
+    # The primary features provided by this class include:
+    # - Custom grouping of records based on predefined logic.
+    # - Control over headers, identity keys, and displayed content organization.
+    #
+    # == Inclusions
+    # This class includes the following modules to extend functionality:
+    # - Refinery::Admin::ImagesHelper: Provides helper methods for working with images.
+    # - ActionView::Helpers::TagHelper: Supplies methods for creating HTML tags.
+    #
+    # == Attributes
+    # - @group_headers: Controls whether headers for each record group are displayed. Defaults to `false`.
+    # - @identity_keys: Represents the keys used to identify and present record attributes, including thumbnail, title, and alt text attributes.
+    # - @header: Stores header configurations, initialized as `nil`.
+    # - @groups: A lambda function designed to group records by associating them with the current date.
+    #
+    # == Initialization
+    # When initialized, `GridPresenter` accepts an execution `context` (e.g., a controller, view, etc.)
+    # and propagates this context to the superclass.
+    class GridPresenter < GroupPresenter
+      include Refinery::Admin::ImagesHelper
+      include ActionView::Helpers::TagHelper
+
+      def initialize(context)
+        super(context)
+        @group_headers = false
+        @identity_keys = [:thumbnail, :title, :alt]
+        @header  = nil
+        @groups = ->(records) { [[Date.today, records]] }
+      end
+
+    end
+  end
+end

data/app/presenters/refinery/admin/group_presenter.rb

@@ -0,0 +1,68 @@
+module Refinery
+  module Admin
+
+    # Refinery::Admin::GroupPresenter
+    #
+    # This class represents a presenter for organizing and displaying
+    # groups with associated metadata in a structured format.
+    #
+    # The presenter utilizes several helper modules for enhanced
+    # functionality and template rendering support.
+    #
+    # == Includes:
+    # * `Refinery::Admin::ImagesHelper` - Provides image-related functionality.
+    # * `ActionView::Helpers::TagHelper` - Used to create HTML-like tags dynamically.
+    #
+    # == Attributes:
+    # * `context` [Object] - Represents the context within which the presenter operates.
+    # * `groups` [Object] - Holds a collection of groups to be managed.
+    # * `group_classes` [Array] - Provides a list of CSS class names applied to the group tag.
+    # * `group_header` [Proc] - Callable object (e.g., lambda) to determine the header for each group.
+    # * `group_headers` [Boolean] - Controls whether group headers are displayed.
+    # * `group_tag` [Symbol] - Defines the tag used to wrap groups, e.g., `:ul`.
+    # * `group_wrapper` [Proc] - Customizable wrapper for rendering group collections.
+    # * `header` [Proc] - Callable object to format the header for individual groups.
+    # * `header_tag` [Symbol] - Specifies the tag for rendering headers, e.g., `:h3`.
+    # * `identity_keys` [Object] - Additional attribute for handling unique identity keys.
+    #
+    # == Public Instance Methods:
+    # - `initialize(context)`
+    #   Initializes a new instance of the presenter within a given context,
+    #   setting default values for various attributes like headers and tags.
+    #
+    # - `group_wrapper(&block)`
+    #   Wraps the rendering of groups using a specified tag.
+    #   This is customizable via the `group_tag` and `group_classes` attributes.
+    #   A block must be passed to render the inner contents.
+    #
+    # - `group_header(date)`
+    #   Constructs a header for individual groups based on a provided date.
+    #   The format of the header is defined by the `header` callable and
+    #   displayed using the specified `header_tag`.
+    class GroupPresenter
+      include Refinery::Admin::ImagesHelper
+      include ActionView::Helpers::TagHelper
+
+      attr_accessor  :context, :groups, :group_classes, :group_header, :group_headers, :group_tag, :group_wrapper,
+                     :header, :header_tag, :identity_keys
+
+      def initialize(context)
+        @context = context
+        @group_headers = true
+        @group_tag = :ul
+        @group_classes = [:image_group]
+        @header_tag = :h3
+      end
+
+      def group_wrapper(&block)
+        context.tag group_tag, class: group_classes do
+          yield block
+        end
+      end
+
+      def group_header(date)
+        tag.send(header_tag, header.call(date), class: :group_header)
+      end
+    end
+  end
+end

data/app/presenters/refinery/admin/image_presenter.rb

@@ -0,0 +1,145 @@
+module Refinery
+  module Admin
+
+    # Refinery::Admin::ImagePresenter
+    #
+    # This class represents a presenter for managing and displaying image data
+    # in the Refinery admin interface. It provides methods to format image-related
+    # data for display and to generate necessary HTML components for interacting
+    # with images in the admin UI.
+    #
+    # === Includes
+    # - ActionView::RecordIdentifier: Provides methods for DOM ID generation for records.
+    # - ActionView::Helpers::UrlHelper: Allows generation of URLs and links.
+    # - ActionView::Helpers::TagHelper: Provides methods for generating HTML tags.
+    # - ActionView::Context: Allows rendering within the correct context.
+    # - Refinery::TranslationHelper: Adds support for translation-related helper methods.
+    # - Refinery::Admin::ImagesHelper: Includes specific helper methods for working with images.
+    # - Refinery::ActionHelper: Provides additional action-based helper methods.
+    #
+    # === Attributes
+    # - `image` [Reader]: The image object being presented.
+    # - `context` [Reader]: Context of the current view, often required for generating paths and URLs.
+    # - `index_keys` [Reader]: Used to specify the attributes displayed in the index table for images.
+    # - `i18n_scope` [Reader]: Specifies the internationalization scope for localization of text.
+    # - `title` [Writer]: Sets the title for the image.
+    # - `alt` [Writer]: Sets the alt text for the image.
+    # - `filename` [Writer]: Sets the filename for the image.
+    # - `translations` [Writer]: Stores translations for the image fields.
+    # - `edit_attributes` [Writer]: Stores attributes to be used for editing the image.
+    # - `delete_attributes` [Writer]: Stores attributes to be used for deleting the image.
+    # - `preview_attributes` [Writer]: Stores attributes for image preview options.
+    #
+    # === Constants
+    # - `IndexEntry`: Defines a structure to hold index entry data, including the image ID,
+    #   edit link, text elements, locales, and actionable items.
+    #
+    # === Instance Methods
+    #
+    # - `initialize(image, context, scope = nil)`:
+    #   Constructor that initializes the ImagePresenter with the given image object, view context,
+    #   and optional internationalization scope.
+    #
+    # - `index_entry(index_keys)`:
+    #   Generates an index entry for the image, including its ID, edit link, text elements,
+    #   and actions. Accepts an array of keys for specifying index fields.
+    #   These keys differ between the grid_view and list_view, and other views could be added
+    #
+    # - `link_to_edit(edit_key)`:
+    #   Creates a link to edit the image, using the given key for determining the "text" of the link.
+    #
+    # - `text_elements(keys)`:
+    #   Generates text  elements for display based on the provided keys, wrapping them in HTML spans.
+    #
+    # - `thumbnail`:
+    #   Returns the thumbnail for the image, including specific attributes such as its
+    #   URL, description (alt) and title
+    class ImagePresenter < Refinery::BasePresenter
+      include ActionView::RecordIdentifier
+      include ActionView::Helpers::UrlHelper
+      include ActionView::Helpers::TagHelper
+      include ActionView::Context
+
+      include Refinery::TranslationHelper
+      include Refinery::Admin::ImagesHelper
+      include Refinery::ActionHelper
+
+      attr_reader :image, :context, :index_keys, :i18n_scope
+      attr_writer :title, :alt, :filename, :translations, :edit_attributes, :delete_attributes, :preview_attributes
+      delegate_missing_to :image
+      delegate :t, to: :context
+
+      IndexEntry = Struct.new('ImageEntry', :id, :edit_link, :text_elements, :locales, :actions)
+
+      def initialize(image, context, scope = nil)
+        super(image)
+        @image = image
+        @context = context
+        @i18n_scope = scope || 'refinery.admin.images'
+      end
+
+      def index_entry(index_keys)
+        edit_key, *text_keys = index_keys
+        IndexEntry.new(
+          id: image.id,
+          edit_link: link_to_edit(index_keys[0]),
+          text_elements: text_elements(index_keys[1..]),
+          actions: tag.span( image_actions, class: :actions)
+        )
+      end
+
+      def link_to_edit(edit_key)
+        link_to(self.send(edit_key),
+                context.edit_admin_image_path(image),
+                { title: ::I18n.t('.edit', title: image.title, scope: i18n_scope), class: :edit_link})
+      end
+
+      def text_elements(keys)
+        keys.reduce(ActiveSupport::SafeBuffer.new) do |buffer, key|
+          buffer << tag.span(self.send(key), title: ::I18n.t(key, scope: i18n_scope), class: key)
+        end
+      end
+
+      def thumbnail
+        tag.img src: image.thumbnail(geometry: Refinery::Images.admin_image_sizes[:grid], strip: true).url(only_path: true),
+                alt: image.alt, title: image.title, class: :thumbnail
+      end
+
+      def title
+        translated_field(image, :title)
+      end
+
+      def alt
+        alt_text = translated_field(@image, :alt)
+        alt_text unless alt_text === translated_field(image, :title)
+      end
+
+      def filename
+        image.image_name
+      end
+
+      def image_actions
+        [*edit_actions, delete_action, preview_action].reduce(ActiveSupport::SafeBuffer.new) do |buffer, action|
+          buffer << action
+        end
+      end
+
+      def edit_actions
+        translated_locales = locales_with_translated_field(image, :image_title)
+        edit_in_locales(context.edit_admin_image_path(image), translated_locales)
+      end
+
+      def preview_action(options = {})
+        action_icon(:preview, image.url, ::I18n.t('.view_live_html', scope: i18n_scope),
+                    options: options)
+      end
+
+      def delete_action(options = {})
+        action_icon(:delete, context.admin_image_path(image),
+                    ::I18n.t('.delete', scope: i18n_scope),
+                    data: { confirm: ::I18n.t('message', scope: 'refinery.admin.delete', title: image.title) },
+                    **options )
+      end
+    end
+  end
+end

data/app/presenters/refinery/admin/list_presenter.rb

@@ -0,0 +1,23 @@
+module Refinery
+  module Admin
+    class ListPresenter < GroupPresenter
+      include Refinery::Admin::ImagesHelper
+      include ActionView::Helpers::TagHelper
+
+      # Initialize the presenter with a context, a lambda for headers, and a lambda for groups.
+      #
+      # @param context [Object] An object that provides the necessary methods for grouping and rendering.
+      # @param header [Proc] Callable for formatting group headers.
+      # @param groups [Proc] Callable for grouping records.
+      def initialize(context,
+                     header: ->(date) { localized(date) },
+                     groups: ->(records) { context.group_by_date(records, :updated_at) })
+        super(context)
+        @identity_keys = [:title, :filename, :alt]
+        @group_headers = true
+        @header = header
+        @groups = groups
+      end
+    end
+  end
+end

data/app/views/refinery/admin/images/_crop.html.erb

@@ -0,0 +1,7 @@
+<%= content_tag :li, id: "crop_#{crop.id}" do %>
+  <%= image_fu crop, '255x255', class: 'brown_border' %>
+  <%= action_icon :delete, refinery.admin_image_crop_path(crop), t('delete', scope: 'refinery.admin.images'),
+    class: 'confirm-delete',
+    data: { confirm: t('message', scope: 'refinery.admin.delete', title: t('.delete_crop', title: crop.parent.title, id: crop.id) ) },
+    remote: true %>
+<% end %>

data/app/views/refinery/admin/images/_existing_image.html.erb

@@ -2,25 +2,49 @@
   <%= render '/refinery/admin/search', :url => refinery.insert_admin_images_path(params.to_unsafe_h.dup.except('image')) %>
   <input type="hidden" name="selected_image" id="selected_image" />
   <div id="existing_image_area_content" class="clearfix">
-<% if @images.any? %>
-    <ul>
-      <% @images.each do |image| -%>
-        <li<%= ' class="selected"'.html_safe if @image_id == image.id %>>
-          <%= image_fu(image, '106x106#c', {
-                         :alt => image.title,
-                         :title => image.title,
-                         :id => "image_#{image.id}",
-                         :'data-id' => image.id
-                       }.merge(thumbnail_urls(image))) -%>
-        </li>
-      <% end -%>
-    </ul>
-<% elsif searching? %>
-    <%= t('no_results', :scope => 'refinery.admin.search') %>
-<% end %>
+    <% if @images.any? %>
+      <ul class="clearfix">
+        <% @images.each do |image| -%>
+          <%= content_tag :li, class: ('selected' if @image_id == image.id) do %>
+            <%= image_fu(image, '106x106#c',
+              alt: image.title,
+              title: image.title,
+              id: dom_id(image),
+              data: {
+                id: image.id,
+                **thumbnail_urls(image)[:data]
+              })-%>
+
+            <% if image.crops.any? %>
+              <div class="crops">
+                <ul class="clearfix">
+                  <% image.crops.each do |crop| %>
+                    <%= content_tag :li, class: ('selected' if @image_id == image.id) do %>
+                      <%= image_fu(crop, '106x106>',
+                          alt: crop.parent.alt,
+                          title: crop.parent.title,
+                          id: "image_#{crop.id}",
+                          data: {
+                            id: crop.id,
+                            **thumbnail_urls(crop)[:data]
+                          }) %>
+                    <% end %>
+                  <% end %>
+                </ul>
+              </div>
+            <% end %>
+          <% end %>
+        <% end %>
+      </ul>
+    <% elsif searching? %>
+      <%= t('no_results', :scope => 'refinery.admin.search') %>
+    <% end %>
   </div>
+
   <%= will_paginate @images, :params => params.to_unsafe_h.dup.merge(:action => "insert") %>
 
+  <div id="existing_image_area_crops" class="clearfix"></div>
+
   <% unless @app_dialog or @images.empty? %>
     <div id="existing_image_size_area" class="clearfix">
       <input type="hidden" name="selected_image_size" id="selected_image_size" />
@@ -30,22 +54,23 @@
           <%= t('.resize_image') %>
         </label>
       </p>
-      <ul>
+
+      <%= select :resize, nil, nil, { prompt: t('.select_resize') }, { id: 'resize'} do %>
         <%
           Refinery::Images.user_image_sizes.sort_by { |key, geometry| geometry.to_i }.each_with_index do |(size, pixels), index|
             safe_pixels = pixels.to_s.gsub(/[<>=]/, '')
             # (parndt): ' selected' if size.to_s == 'medium' is not very generic, but I
             # can't think of a decent way of making it so for even sets (e.g. 2,4,6,8,etc image sizes).
-        -%>
-            <li id="image_dialog_size_<%= index %>" class="image_dialog_size<%= ' selected' if size.to_s == 'medium' %>">
-              <%= link_to size.to_s, "##{size}",
-                          :'data-geometry' => pixels,
-                          :'data-size' => size.to_s.parameterize,
-                          :title   => "#{size} image (#{safe_pixels})",
-                          :tooltip => "#{size} image (#{safe_pixels})" %>
-            </li>
-        <% end -%>
-      </ul>
+        %>
+          <%= content_tag :option,
+                          "#{size} image (#{safe_pixels})",
+                          value: size.to_s.parameterize,
+                          id: "image_dialog_size_#{index}",
+                          data: { geometry: pixels, size: size.to_s.parameterize },
+                          selected: (true if size.to_s == 'medium')
+          %>
+        <% end %>
+      <% end %>
     </div>
   <% end %>