alchemy_cms 5.0.3 → 5.1.1

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

@@ -175,7 +175,8 @@ module Alchemy
       # Returns true if the given entry's controller is current controller
       #
       def is_entry_controller_active?(entry)
-        entry["controller"].gsub(/\A\//, "") == params[:controller]
+        entry["controller"].gsub(/\A\//, "") == params[:controller] ||
+          entry.fetch("nested_controllers", []).include?(params[:controller])
       end
 
       # Returns true if the given entry's action is current controllers action

data/app/models/alchemy/attachment.rb

@@ -37,6 +37,20 @@ module Alchemy
 
     # We need to define this method here to have it available in the validations below.
     class << self
+      # The class used to generate URLs for attachments
+      #
+      # @see Alchemy::Attachment::Url
+      def url_class
+        @_url_class ||= Alchemy::Attachment::Url
+      end
+
+      # Set a different attachment url class
+      #
+      # @see Alchemy::Attachment::Url
+      def url_class=(klass)
+        @_url_class = klass
+      end
+
       def searchable_alchemy_resource_attributes
         %w(name file_name)
       end
@@ -76,14 +90,17 @@ module Alchemy
       }
     end
 
+    def url(options = {})
+      if file
+        self.class.url_class.new(self).call(options)
+      end
+    end
+
     # An url save filename without format suffix
     def slug
       CGI.escape(file_name.gsub(/\.#{extension}$/, "").tr(".", " "))
     end
 
-    alias_method :urlname, :slug
-    deprecate urlname: :slug, deprecator: Alchemy::Deprecation
-
     # Checks if the attachment is restricted, because it is attached on restricted pages only
     def restricted?
       pages.any? && pages.not_restricted.blank?

data/app/models/alchemy/attachment/url.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Alchemy
+  class Attachment < BaseRecord
+    # The class representing an URL to an attachment
+    #
+    # Set a different one
+    #
+    #     Alchemy::Attachment.url_class = MyRemoteUrlClass
+    #
+    class Url
+      def initialize(attachment)
+        @attachment = attachment
+      end
+
+      # The attachment url
+      #
+      # @param [Hash] options
+      # @option options [Symbol] :download return a URL for downloading the attachment
+      # @option options [Symbol] :name The filename
+      # @option options [Symbol] :format The file extension
+      #
+      # @return [String]
+      #
+      def call(options = {})
+        if options.delete(:download)
+          routes.download_attachment_path(@attachment, options)
+        else
+          routes.show_attachment_path(@attachment, options)
+        end
+      end
+
+      private
+
+      def routes
+        Alchemy::Engine.routes.url_helpers
+      end
+    end
+  end
+end

data/app/models/alchemy/essence_picture.rb

@@ -62,7 +62,7 @@ module Alchemy
     def picture_url(options = {})
       return if picture.nil?
 
-      picture.url picture_url_options.merge(options)
+      picture.url(picture_url_options.merge(options)) || "missing-image.png"
     end
 
     # Picture rendering options
@@ -103,7 +103,7 @@ module Alchemy
         format: picture.image_file_format,
       }
 
-      picture.url(options)
+      picture.url(options) || "alchemy/missing-image.svg"
     end
 
     # The name of the picture used as preview text in element editor views.
@@ -140,7 +140,7 @@ module Alchemy
     # Show image cropping link for content
     def allow_image_cropping?
       content && content.settings[:crop] && picture &&
-        picture.can_be_cropped_to(
+        picture.can_be_cropped_to?(
           content.settings[:size],
           content.settings[:upsample],
         ) && !!picture.image_file

data/app/models/alchemy/essence_picture_view.rb

@@ -44,17 +44,19 @@ module Alchemy
       end
     end
 
-    private
-
     def caption
       return unless show_caption?
 
       @_caption ||= content_tag(:figcaption, essence.caption)
     end
 
+    def src
+      essence.picture_url(options.except(*DEFAULT_OPTIONS.keys))
+    end
+
     def img_tag
       @_img_tag ||= image_tag(
-        essence.picture_url(options.except(*DEFAULT_OPTIONS.keys)), {
+        src, {
           alt: alt_text,
           title: essence.title.presence,
           class: caption ? nil : essence.css_class.presence,

data/app/models/alchemy/legacy_page_url.rb

@@ -18,5 +18,5 @@ class Alchemy::LegacyPageUrl < ActiveRecord::Base
 
   validates :urlname,
     presence: true,
-    format: {with: /\A[:\.\w\-+_\/\?&%;=]*\z/}
+    format: {with: /\A[:\.\w\-+_\/\?&%;=#]*\z/}
 end

data/app/models/alchemy/page.rb

@@ -149,6 +149,29 @@ module Alchemy
     # Class methods
     #
     class << self
+      # The url_path class
+      # @see Alchemy::Page::UrlPath
+      def url_path_class
+        @_url_path_class ||= Alchemy::Page::UrlPath
+      end
+
+      # Set a custom url path class
+      #
+      #     # config/initializers/alchemy.rb
+      #     Alchemy::Page.url_path_class = MyPageUrlPathClass
+      #
+      def url_path_class=(klass)
+        @_url_path_class = klass
+      end
+
+      def alchemy_resource_filters
+        %w[published not_public restricted]
+      end
+
+      def searchable_alchemy_resource_attributes
+        %w[name urlname title]
+      end
+
       # Used to store the current page previewed in the edit page template.
       #
       def current_preview=(page)
@@ -298,7 +321,7 @@ module Alchemy
     #
     # @see Alchemy::Page::UrlPath#call
     def url_path
-      Alchemy::Page::UrlPath.new(self).call
+      self.class.url_path_class.new(self).call
     end
 
     # The page's view partial is dependent from its page layout

data/app/models/alchemy/page/page_natures.rb

@@ -17,6 +17,8 @@ module Alchemy
       definition["taggable"] == true
     end
 
+    deprecate :taggable?, deprecator: Alchemy::Deprecation
+
     def rootpage?
       !new_record? && parent_id.blank?
     end

data/app/models/alchemy/page/url_path.rb

@@ -20,8 +20,6 @@ module Alchemy
     #     link_to page.url
     #
     class UrlPath
-      ROOT_PATH = "/"
-
       def initialize(page)
         @page = page
         @language = @page.language
@@ -41,7 +39,7 @@ module Alchemy
       private
 
       def language_root_path
-        @language.default? ? ROOT_PATH : language_path
+        @language.default? ? root_path : language_path
       end
 
       def page_path_with_language_prefix
@@ -49,15 +47,19 @@ module Alchemy
       end
 
       def page_path_with_leading_slash
-        @page.language_root? ? ROOT_PATH : page_path
+        @page.language_root? ? root_path : page_path
       end
 
       def language_path
-        "/#{@page.language_code}"
+        "#{root_path}#{@page.language_code}"
       end
 
       def page_path
-        "/#{@page.urlname}"
+        "#{root_path}#{@page.urlname}"
+      end
+
+      def root_path
+        Engine.routes.url_helpers.root_path
       end
     end
   end

data/app/models/alchemy/picture.rb

@@ -30,11 +30,22 @@ module Alchemy
 
     CONVERTIBLE_FILE_FORMATS = %w(gif jpg jpeg png).freeze
 
+    TRANSFORMATION_OPTIONS = [
+      :crop,
+      :crop_from,
+      :crop_size,
+      :flatten,
+      :format,
+      :quality,
+      :size,
+      :upsample,
+    ]
+
+    include Alchemy::Logger
     include Alchemy::NameConversions
     include Alchemy::Taggable
     include Alchemy::TouchElements
-    include Alchemy::Picture::Transformations
-    include Alchemy::Picture::Url
+    include Calculations
 
     has_many :essence_pictures,
       class_name: "Alchemy::EssencePicture",
@@ -44,6 +55,7 @@ module Alchemy
     has_many :contents, through: :essence_pictures
     has_many :elements, through: :contents
     has_many :pages, through: :elements
+    has_many :thumbs, class_name: "Alchemy::PictureThumb", dependent: :destroy
 
     # Raise error, if picture is in use (aka. assigned to an EssencePicture)
     #
@@ -78,6 +90,9 @@ module Alchemy
       end
     end
 
+    # Create important thumbnails upfront
+    after_create -> { PictureThumb.generate_thumbs!(self) }
+
     # We need to define this method here to have it available in the validations below.
     class << self
       def allowed_filetypes
@@ -103,6 +118,20 @@ module Alchemy
     # Class methods
 
     class << self
+      # The class used to generate URLs for pictures
+      #
+      # @see Alchemy::Picture::Url
+      def url_class
+        @_url_class ||= Alchemy::Picture::Url
+      end
+
+      # Set a different picture url class
+      #
+      # @see Alchemy::Picture::Url
+      def url_class=(klass)
+        @_url_class = klass
+      end
+
       def searchable_alchemy_resource_attributes
         %w(name image_file_name)
       end
@@ -145,6 +174,33 @@ module Alchemy
 
     # Instance methods
 
+    # Returns an url (or relative path) to a processed image for use inside an image_tag helper.
+    #
+    # Any additional options are passed to the url method, so you can add params to your url.
+    #
+    # Example:
+    #
+    #   <%= image_tag picture.url(size: '320x200', format: 'png') %>
+    #
+    # @see Alchemy::PictureVariant#call for transformation options
+    # @see Alchemy::Picture::Url#call for url options
+    # @return [String|Nil]
+    def url(options = {})
+      return unless image_file
+
+      variant = PictureVariant.new(self, options.slice(*TRANSFORMATION_OPTIONS))
+      self.class.url_class.new(variant).call(
+        options.except(*TRANSFORMATION_OPTIONS).merge(
+          basename: name,
+          ext: variant.render_format,
+          name: name,
+        )
+      )
+    rescue ::Dragonfly::Job::Fetch::NotFound => e
+      log_warning(e.message)
+      nil
+    end
+
     def previous(params = {})
       query = Picture.ransack(params[:q])
       Picture.search_by(params, query).where("name < ?", name).last

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

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Alchemy
+  class Picture < BaseRecord
+    module Calculations
+      # An Image smaller than dimensions
+      # can not be cropped to given size - unless upsample is true.
+      #
+      def can_be_cropped_to?(string, upsample = false)
+        return true if upsample
+
+        is_bigger_than? sizes_from_string(string)
+      end
+
+      # Returns true if both dimensions of the base image are bigger than the dimensions hash.
+      #
+      def is_bigger_than?(dimensions)
+        image_file_width > dimensions[:width] && image_file_height > dimensions[:height]
+      end
+
+      # Returns true is one dimension of the base image is smaller than the dimensions hash.
+      #
+      def is_smaller_than?(dimensions)
+        !is_bigger_than?(dimensions)
+      end
+
+      # Given a string with an x, this function returns a Hash with point
+      # :width and :height.
+      #
+      def sizes_from_string(string = "0x0")
+        string = "0x0" if string.nil? || string.empty?
+
+        raise ArgumentError unless string =~ /(\d*x\d*)/
+
+        width, height = string.scan(/(\d*)x(\d*)/)[0].map(&:to_i)
+
+        width = 0 if width.nil?
+        height = 0 if height.nil?
+        {
+          width: width,
+          height: height,
+        }
+      end
+
+      # This function returns the :width and :height of the image file
+      # as a Hash
+      def image_size
+        {
+          width: image_file_width,
+          height: image_file_height,
+        }
+      end
+    end
+  end
+end

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

@@ -7,6 +7,10 @@ module Alchemy
   module Picture::Transformations
     extend ActiveSupport::Concern
 
+    included do
+      include Alchemy::Picture::Calculations
+    end
+
     THUMBNAIL_WIDTH = 160
     THUMBNAIL_HEIGHT = 120
 
@@ -66,24 +70,6 @@ module Alchemy
       image_file.thumb(upsample ? size : "#{size}>")
     end
 
-    # Given a string with an x, this function returns a Hash with point
-    # :width and :height.
-    #
-    def sizes_from_string(string = "0x0")
-      string = "0x0" if string.nil? || string.empty?
-
-      raise ArgumentError unless string =~ /(\d*x\d*)/
-
-      width, height = string.scan(/(\d*)x(\d*)/)[0].map(&:to_i)
-
-      width = 0 if width.nil?
-      height = 0 if height.nil?
-      {
-        width: width,
-        height: height,
-      }
-    end
-
     # Returns true if picture's width is greater than it's height
     #
     def landscape_format?
@@ -105,24 +91,6 @@ module Alchemy
     end
     alias_method :square?, :square_format?
 
-    # This function returns the :width and :height of the image file
-    # as a Hash
-    def image_size
-      {
-        width: image_file_width,
-        height: image_file_height,
-      }
-    end
-
-    # An Image smaller than dimensions
-    # can not be cropped to given size - unless upsample is true.
-    #
-    def can_be_cropped_to(string, upsample = false)
-      return true if upsample
-
-      is_bigger_than sizes_from_string(string)
-    end
-
     # Returns true if the class we're included in has a meaningful render_size attribute
     #
     def render_size?
@@ -217,22 +185,10 @@ module Alchemy
       "#{dimensions[:width]}x#{dimensions[:height]}"
     end
 
-    # Returns true if both dimensions of the base image are bigger than the dimensions hash.
-    #
-    def is_bigger_than(dimensions)
-      image_file_width > dimensions[:width] && image_file_height > dimensions[:height]
-    end
-
-    # Returns true is one dimension of the base image is smaller than the dimensions hash.
-    #
-    def is_smaller_than(dimensions)
-      !is_bigger_than(dimensions)
-    end
-
     # Uses imagemagick to make a centercropped thumbnail. Does not scale the image up.
     #
     def center_crop(dimensions, upsample)
-      if is_smaller_than(dimensions) && upsample == false
+      if is_smaller_than?(dimensions) && upsample == false
         dimensions = reduce_to_image(dimensions)
       end
       image_file.thumb("#{dimensions_to_string(dimensions)}#")