alchemy_cms 5.2.0 → 6.0.0.b3

data/app/models/alchemy/picture/preprocessor.rb

@@ -16,6 +16,8 @@ module Alchemy
       def call
         max_image_size = Alchemy::Config.get(:preprocess_image_resize)
         image_file.thumb!(max_image_size) if max_image_size.present?
+        # Auto orient the image so EXIF orientation data is taken into account
+        image_file.auto_orient!
       end
 
       private

data/app/models/alchemy/picture/transformations.rb

@@ -11,53 +11,16 @@ module Alchemy
       include Alchemy::Picture::Calculations
     end
 
-    THUMBNAIL_WIDTH = 160
-    THUMBNAIL_HEIGHT = 120
-
-    # Returns the default centered image mask for a given size.
-    # If the mask is bigger than the image, the mask is scaled down
-    # so the largest possible part of the image is visible.
-    #
-    def default_mask(mask_arg)
-      mask = mask_arg.dup
-      mask[:width] = image_file_width if mask[:width].zero?
-      mask[:height] = image_file_height if mask[:height].zero?
-
-      crop_size = size_when_fitting({width: image_file_width, height: image_file_height}, mask)
-      top_left = get_top_left_crop_corner(crop_size)
-
-      point_and_mask_to_points(top_left, crop_size)
-    end
-
-    # Returns a size value String for the thumbnail used in essence picture editors.
-    #
-    def thumbnail_size(size_string = "0x0", crop = false)
-      size = sizes_from_string(size_string)
-
-      # only if crop is set do we need to actually parse the size string, otherwise
-      # we take the base image size.
-      if crop
-        size[:width] = get_base_dimensions[:width] if size[:width].zero?
-        size[:height] = get_base_dimensions[:height] if size[:height].zero?
-        size = reduce_to_image(size)
-      else
-        size = get_base_dimensions
-      end
-
-      size = size_when_fitting({width: THUMBNAIL_WIDTH, height: THUMBNAIL_HEIGHT}, size)
-      "#{size[:width]}x#{size[:height]}"
-    end
-
     # Returns the rendered cropped image. Tries to use the crop_from and crop_size
     # parameters. When they can't be parsed, it just crops from the center.
     #
     def crop(size, crop_from = nil, crop_size = nil, upsample = false)
       raise "No size given!" if size.empty?
 
-      render_to = sizes_from_string(size)
+      render_to = inferred_sizes_from_string(size)
       if crop_from && crop_size
         top_left = point_from_string(crop_from)
-        crop_dimensions = sizes_from_string(crop_size)
+        crop_dimensions = inferred_sizes_from_string(crop_size)
         xy_crop_resize(render_to, top_left, crop_dimensions, upsample)
       else
         center_crop(render_to, upsample)
@@ -75,21 +38,30 @@ module Alchemy
     def landscape_format?
       image_file.landscape?
     end
+
     alias_method :landscape?, :landscape_format?
+    deprecate landscape_format?: "Use image_file.landscape? instead", deprecator: Alchemy::Deprecation
+    deprecate landscape?: "Use image_file.landscape? instead", deprecator: Alchemy::Deprecation
 
     # Returns true if picture's width is smaller than it's height
     #
     def portrait_format?
       image_file.portrait?
     end
+
     alias_method :portrait?, :portrait_format?
+    deprecate portrait_format?: "Use image_file.portrait? instead", deprecator: Alchemy::Deprecation
+    deprecate portrait?: "Use image_file.portrait? instead", deprecator: Alchemy::Deprecation
 
     # Returns true if picture's width and height is equal
     #
     def square_format?
       image_file.aspect_ratio == 1.0
     end
+
     alias_method :square?, :square_format?
+    deprecate square_format?: "Use image_file.aspect_ratio instead", deprecator: Alchemy::Deprecation
+    deprecate square?: "Use image_file.aspect_ratio instead", deprecator: Alchemy::Deprecation
 
     # Returns true if the class we're included in has a meaningful render_size attribute
     #
@@ -121,62 +93,18 @@ module Alchemy
       }
     end
 
-    # Given dimensions for a possibly destructive crop operation,
-    # this function returns the top left corner as a Hash
-    # with keys :x, :y
-    #
-    def get_top_left_crop_corner(dimensions)
-      {
-        x: (image_file_width - dimensions[:width]) / 2,
-        y: (image_file_height - dimensions[:height]) / 2,
-      }
-    end
+    def inferred_sizes_from_string(string)
+      sizes = sizes_from_string(string)
+      ratio = image_file_width.to_f / image_file_height
 
-    # Gets the base dimensions (the dimensions of the Picture before scaling).
-    # If anything is missing, it gets padded with zero (Integer 0).
-    # This is the order of precedence: crop_size > image_size
-    def get_base_dimensions
-      if crop_size?
-        sizes_from_string(crop_size)
-      else
-        image_size
+      if sizes[:width].zero?
+        sizes[:width] = image_file_width * ratio
       end
-    end
-
-    # This function takes a target and a base dimensions hash and returns
-    # the dimensions of the image when the base dimensions hash fills
-    # the target.
-    #
-    # Aspect ratio will be preserved.
-    #
-    def size_when_fitting(target, dimensions = get_base_dimensions)
-      zoom = [
-        dimensions[:width].to_f / target[:width],
-        dimensions[:height].to_f / target[:height],
-      ].max
-
-      if zoom == 0.0
-        width = target[:width]
-        height = target[:height]
-      else
-        width = (dimensions[:width] / zoom).round
-        height = (dimensions[:height] / zoom).round
+      if sizes[:height].zero?
+        sizes[:height] = image_file_width / ratio
       end
 
-      {width: width.to_i, height: height.to_i}
-    end
-
-    # Given a point as a Hash with :x and :y, and a mask with
-    # :width and :height, this function returns the area on the
-    # underlying canvas as a Hash of two points
-    #
-    def point_and_mask_to_points(point, mask)
-      {
-        x1: point[:x],
-        y1: point[:y],
-        x2: point[:x] + mask[:width],
-        y2: point[:y] + mask[:height],
-      }
+      sizes
     end
 
     # Converts a dimensions hash to a string of from "20x20"
@@ -197,20 +125,20 @@ module Alchemy
     # Use imagemagick to custom crop an image. Uses -thumbnail for better performance when resizing.
     #
     def xy_crop_resize(dimensions, top_left, crop_dimensions, upsample)
-      crop_argument = "-crop #{dimensions_to_string(crop_dimensions)}"
+      crop_argument = dimensions_to_string(crop_dimensions)
       crop_argument += "+#{top_left[:x]}+#{top_left[:y]}"
 
-      resize_argument = "-resize #{dimensions_to_string(dimensions)}"
+      resize_argument = dimensions_to_string(dimensions)
       resize_argument += ">" unless upsample
-      image_file.convert "#{crop_argument} #{resize_argument}"
+      image_file.crop_resize(crop_argument, resize_argument)
     end
 
     # Used when centercropping.
     #
     def reduce_to_image(dimensions)
       {
-        width: [dimensions[:width], image_file_width].min,
-        height: [dimensions[:height], image_file_height].min,
+        width: [dimensions[:width].to_i, image_file_width.to_i].min,
+        height: [dimensions[:height].to_i, image_file_height.to_i].min,
       }
     end
   end

data/app/models/concerns/alchemy/picture_thumbnails.rb

@@ -0,0 +1,181 @@
+# frozen_string_literal: true
+
+module Alchemy
+  # Picture thumbnails and cropping concerns
+  module PictureThumbnails
+    extend ActiveSupport::Concern
+
+    included do
+      before_save :fix_crop_values
+
+      delegate :image_file_width, :image_file_height, :image_file, to: :picture, allow_nil: true
+    end
+
+    # The url to show the picture.
+    #
+    # Takes all values like +name+ and crop sizes (+crop_from+, +crop_size+ from the build in graphical image cropper)
+    # and also adds the security token.
+    #
+    # You typically want to set the size the picture should be resized to.
+    #
+    # === Example:
+    #
+    #   essence_picture.picture_url(size: '200x300', crop: true, format: 'gif')
+    #   # '/pictures/1/show/200x300/crop/cats.gif?sh=765rfghj'
+    #
+    # @option options size [String]
+    #   The size the picture should be resized to.
+    #
+    # @option options format [String]
+    #   The format the picture should be rendered in.
+    #   Defaults to the +image_output_format+ from the +Alchemy::Config+.
+    #
+    # @option options crop [Boolean]
+    #   If set to true the picture will be cropped to fit the size value.
+    #
+    # @return [String]
+    def picture_url(options = {})
+      return if picture.nil?
+
+      picture.url(picture_url_options.merge(options)) || "missing-image.png"
+    end
+
+    # Picture rendering options
+    #
+    # Returns the +default_render_format+ of the associated +Alchemy::Picture+
+    # together with the +crop_from+ and +crop_size+ values
+    #
+    # @return [HashWithIndifferentAccess]
+    def picture_url_options
+      return {} if picture.nil?
+
+      crop = !!settings[:crop]
+
+      {
+        format: picture.default_render_format,
+        crop: crop,
+        crop_from: crop && crop_from.presence || nil,
+        crop_size: crop && crop_size.presence || nil,
+        size: settings[:size],
+      }.with_indifferent_access
+    end
+
+    # Returns an url for the thumbnail representation of the assigned picture
+    #
+    # It takes cropping values into account, so it always represents the current
+    # image displayed in the frontend.
+    #
+    # @return [String]
+    def thumbnail_url
+      return if picture.nil?
+
+      picture.url(thumbnail_url_options) || "alchemy/missing-image.svg"
+    end
+
+    # Thumbnail rendering options
+    #
+    # @return [HashWithIndifferentAccess]
+    def thumbnail_url_options
+      crop = !!settings[:crop]
+
+      {
+        size: "160x120",
+        crop: crop,
+        crop_from: crop && crop_from.presence || default_crop_from&.join("x"),
+        crop_size: crop && crop_size.presence || default_crop_size&.join("x"),
+        flatten: true,
+        format: picture&.image_file_format || "jpg",
+      }
+    end
+
+    # Settings for the graphical JS image cropper
+    def image_cropper_settings
+      Alchemy::ImageCropperSettings.new(
+        render_size: dimensions_from_string(render_size.presence || settings[:size]),
+        default_crop_from: default_crop_from,
+        default_crop_size: default_crop_size,
+        fixed_ratio: settings[:fixed_ratio],
+        image_width: picture&.image_file_width,
+        image_height: picture&.image_file_height,
+      ).to_h
+    end
+
+    # Show image cropping link for content
+    def allow_image_cropping?
+      settings[:crop] && picture &&
+        picture.can_be_cropped_to?(
+          settings[:size],
+          settings[:upsample],
+        ) && !!picture.image_file
+    end
+
+    private
+
+    def default_crop_size
+      return nil unless settings[:crop] && settings[:size]
+
+      mask = inferred_dimensions_from_string(settings[:size])
+      zoom = thumbnail_zoom_factor(mask)
+      return nil if zoom.zero?
+
+      [(mask[0] / zoom), (mask[1] / zoom)].map(&:round)
+    end
+
+    def thumbnail_zoom_factor(mask)
+      [
+        mask[0].to_f / (image_file_width || 1),
+        mask[1].to_f / (image_file_height || 1),
+      ].max
+    end
+
+    def default_crop_from
+      return nil unless settings[:crop]
+      return nil if default_crop_size.nil?
+
+      [
+        ((image_file_width || 0) - default_crop_size[0]) / 2,
+        ((image_file_height || 0) - default_crop_size[1]) / 2,
+      ].map(&:round)
+    end
+
+    def dimensions_from_string(string)
+      return if string.nil?
+
+      string.split("x", 2).map(&:to_i)
+    end
+
+    def inferred_dimensions_from_string(string)
+      return if string.nil?
+
+      width, height = dimensions_from_string(string)
+      ratio = image_file_width.to_f / image_file_height.to_i
+
+      if width.zero? && ratio.is_a?(Float)
+        width = height * ratio
+      end
+
+      if height.zero? && ratio.is_a?(Float)
+        height = width / ratio
+      end
+
+      [width.to_i, height.to_i]
+    end
+
+    def fix_crop_values
+      %i[crop_from crop_size].each do |crop_value|
+        if public_send(crop_value).is_a?(String)
+          public_send("#{crop_value}=", normalize_crop_value(crop_value))
+        end
+      end
+    end
+
+    def normalize_crop_value(crop_value)
+      public_send(crop_value).split("x").map { |n| normalize_number(n) }.join("x")
+    end
+
+    def normalize_number(number)
+      number = number.to_f.round
+      number.negative? ? 0 : number
+    end
+  end
+end

data/app/models/concerns/alchemy/touch_elements.rb

@@ -10,7 +10,7 @@ module Alchemy
   #
   module TouchElements
     def self.included(base)
-      base.after_save(:touch_elements)
+      base.after_update(:touch_elements)
     end
 
     private
@@ -18,7 +18,7 @@ module Alchemy
     def touch_elements
       return unless respond_to?(:elements)
 
-      elements.map(&:touch)
+      elements.touch_all
     end
   end
 end

data/app/presenters/alchemy/picture_view.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+module Alchemy
+  # Renders a picture ingredient view
+  class PictureView
+    include ActionView::Helpers::AssetTagHelper
+    include ActionView::Helpers::UrlHelper
+    include Rails.application.routes.url_helpers
+
+    attr_reader :ingredient, :html_options, :options, :picture
+
+    DEFAULT_OPTIONS = {
+      show_caption: true,
+      disable_link: false,
+      srcset: [],
+      sizes: [],
+    }.with_indifferent_access
+
+    def initialize(ingredient, options = {}, html_options = {})
+      @ingredient = ingredient
+      @options = DEFAULT_OPTIONS.merge(ingredient.settings).merge(options || {})
+      @html_options = html_options || {}
+      @picture = ingredient.picture
+    end
+
+    def render
+      return if picture.blank?
+
+      output = caption ? img_tag + caption : img_tag
+
+      if is_linked?
+        output = link_to(output, url_for(ingredient.link), {
+          title: ingredient.link_title.presence,
+          target: ingredient.link_target == "blank" ? "_blank" : nil,
+          data: { link_target: ingredient.link_target.presence },
+        })
+      end
+
+      if caption
+        content_tag(:figure, output, { class: ingredient.css_class.presence }.merge(html_options))
+      else
+        output
+      end
+    end
+
+    def caption
+      return unless show_caption?
+
+      @_caption ||= content_tag(:figcaption, ingredient.caption)
+    end
+
+    def src
+      ingredient.picture_url(options.except(*DEFAULT_OPTIONS.keys))
+    end
+
+    def img_tag
+      @_img_tag ||= image_tag(
+        src, {
+          alt: alt_text,
+          title: ingredient.title.presence,
+          class: caption ? nil : ingredient.css_class.presence,
+          srcset: srcset.join(", ").presence,
+          sizes: options[:sizes].join(", ").presence,
+        }.merge(caption ? {} : html_options)
+      )
+    end
+
+    def show_caption?
+      options[:show_caption] && ingredient.caption.present?
+    end
+
+    def is_linked?
+      !options[:disable_link] && ingredient.link.present?
+    end
+
+    def srcset
+      options[:srcset].map do |size|
+        url = ingredient.picture_url(size: size)
+        width, height = size.split("x")
+        width.present? ? "#{url} #{width}w" : "#{url} #{height}h"
+      end
+    end
+
+    def alt_text
+      ingredient.alt_tag.presence || html_options.delete(:alt) || ingredient.picture.name&.humanize
+    end
+  end
+end