alchemy_cms 5.2.1 → 6.0.0.b1

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

@@ -3,110 +3,121 @@
 module Alchemy
   # ActiveRecord scopes for Alchemy::Page
   #
-  module Page::PageScopes
-    extend ActiveSupport::Concern
-
-    included do
-      # All language root pages
-      #
-      scope :language_roots, -> { where(language_root: true) }
-
-      # All layout pages
-      #
-      scope :layoutpages, -> { where(layoutpage: true) }
-
-      # All locked pages
-      #
-      scope :locked, -> { where.not(locked_at: nil).where.not(locked_by: nil) }
-
-      # All pages locked by given user
-      #
-      scope :locked_by,
-        ->(user) {
-          if user.class.respond_to? :primary_key
-            locked.where(locked_by: user.send(user.class.primary_key))
-          end
-        }
-
-      # All not locked pages
-      #
-      scope :not_locked, -> { where(locked_at: nil, locked_by: nil) }
-
-      # All not restricted pages
-      #
-      scope :not_restricted, -> { where(restricted: false) }
-
-      # All restricted pages
-      #
-      scope :restricted, -> { where(restricted: true) }
-
-      # All pages that are a published language root
-      #
-      scope :public_language_roots,
-        -> {
-          published.language_roots.where(
-            language_code: Language.published.pluck(:language_code),
-          )
-        }
-
-      # Last 5 pages that where recently edited by given user
-      #
-      scope :all_last_edited_from,
-        ->(user) {
-          where(updater_id: user.id).order("updated_at DESC").limit(5)
-        }
-
-      # Returns all pages that have the given +language_id+
-      #
-      scope :with_language, ->(language_id) { where(language_id: language_id) }
-
-      # Returns all content pages.
-      #
-      scope :contentpages, -> { where(layoutpage: [false, nil]) }
-
-      # Returns all public contentpages that are not locked.
-      #
-      # Used for flushing all pages caches at once.
-      #
-      scope :flushables, -> { not_locked.published.contentpages }
-
-      # Returns all layoutpages that are not locked.
-      #
-      # Used for flushing all pages caches at once.
-      #
-      scope :flushable_layoutpages, -> { not_locked.layoutpages }
-
-      # All searchable pages
-      #
-      scope :searchables, -> { not_restricted.published.contentpages }
-
-      # All pages from +Alchemy::Site.current+
-      #
-      scope :from_current_site,
-        -> {
-          where(Language.table_name => { site_id: Site.current || Site.default }).joins(:language)
-        }
-
-      # All pages for xml sitemap
-      #
-      scope :sitemap, -> { from_current_site.published.contentpages.where(sitemap: true) }
-    end
-
-    module ClassMethods
-      # All public pages
-      #
-      def published
-        where("#{table_name}.public_on <= :time AND " \
-              "(#{table_name}.public_until IS NULL " \
-              "OR #{table_name}.public_until >= :time)", time: Time.current)
+  class Page < BaseRecord
+    module PageScopes
+      extend ActiveSupport::Concern
+
+      included do
+        # All language root pages
+        #
+        scope :language_roots, -> { where(language_root: true) }
+
+        # All layout pages
+        #
+        scope :layoutpages, -> { where(layoutpage: true) }
+
+        # All locked pages
+        #
+        scope :locked, -> { where.not(locked_at: nil).where.not(locked_by: nil) }
+
+        # All pages locked by given user
+        #
+        scope :locked_by,
+          ->(user) {
+            if user.class.respond_to? :primary_key
+              locked.where(locked_by: user.send(user.class.primary_key))
+            end
+          }
+
+        # All not locked pages
+        #
+        scope :not_locked, -> { where(locked_at: nil, locked_by: nil) }
+
+        # All not restricted pages
+        #
+        scope :not_restricted, -> { where(restricted: false) }
+
+        # All restricted pages
+        #
+        scope :restricted, -> { where(restricted: true) }
+
+        # All public pages
+        #
+        scope :published,
+          -> {
+            joins(:language, :versions).
+              merge(Language.published).
+              merge(PageVersion.public_on(Time.current))
+          }
+
+        # All pages that are a published language root
+        #
+        scope :public_language_roots,
+          -> {
+            published.language_roots.where(
+              language_code: Language.published.pluck(:language_code),
+            )
+          }
+
+        # Last 5 pages that where recently edited by given user
+        #
+        scope :all_last_edited_from,
+          ->(user) {
+            where(updater_id: user.id).order("updated_at DESC").limit(5)
+          }
+
+        # Returns all pages that have the given +language_id+
+        #
+        scope :with_language, ->(language_id) { where(language_id: language_id) }
+
+        # Returns all content pages.
+        #
+        scope :contentpages, -> { where(layoutpage: [false, nil]) }
+
+        # Returns all public contentpages that are not locked.
+        #
+        # Used for flushing all pages caches at once.
+        #
+        scope :flushables, -> { not_locked.published.contentpages }
+
+        # Returns all layoutpages that are not locked.
+        #
+        # Used for flushing all pages caches at once.
+        #
+        scope :flushable_layoutpages, -> { not_locked.layoutpages }
+
+        # All searchable pages
+        #
+        scope :searchables, -> { not_restricted.published.contentpages }
+
+        # All pages from +Alchemy::Site.current+
+        #
+        scope :from_current_site,
+          -> {
+            where(Language.table_name => { site_id: Site.current || Site.default }).joins(:language)
+          }
+
+        # All pages for xml sitemap
+        #
+        scope :sitemap, -> { from_current_site.published.contentpages.where(sitemap: true) }
       end
 
-      # All not public pages
-      #
-      def not_public
-        where("#{table_name}.public_on IS NULL OR " \
-              "#{table_name}.public_on >= :time OR " \
-              "#{table_name}.public_until <= :time", time: Time.current)
+      module ClassMethods
+        # All pages that do not have any public version
+        #
+        def not_public(time = Time.current)
+          where <<~SQL
+            alchemy_pages.id NOT IN (
+              SELECT alchemy_page_versions.page_id
+              FROM alchemy_page_versions
+              WHERE alchemy_page_versions.public_on <= '#{connection.quoted_date(time)}'
+              AND (
+                alchemy_page_versions.public_until IS NULL
+                OR alchemy_page_versions.public_until >= '#{connection.quoted_date(time)}'
+              )
+            )
+          SQL
+        end
       end
     end
   end

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

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require_dependency "alchemy/page"
+
+module Alchemy
+  class Page < BaseRecord
+    # Handles publishing of pages
+    class Publisher
+      def initialize(page)
+        @page = page
+      end
+
+      # Copies all currently visible elements to the public version of page
+      #
+      # Creates a new published version if none exists yet.
+      #
+      # Sends a publish notification to all registered publish targets
+      #
+      def publish!(public_on:)
+        Page.transaction do
+          version = public_version(public_on)
+          DeleteElements.new(version.elements).call
+
+          repository = page.draft_version.element_repository
+          ActiveRecord::Base.no_touching do
+            Element.acts_as_list_no_update do
+              repository.visible.not_nested.each.with_index(1) do |element, position|
+                Alchemy::DuplicateElement.new(element, repository: repository).call(
+                  page_version_id: version.id,
+                  position: position
+                )
+              end
+            end
+          end
+        end
+
+        Alchemy.publish_targets.each { |p| p.perform_later(page) }
+      end
+
+      private
+
+      attr_reader :page
+
+      # Load the pages public version or create one
+      def public_version(public_on)
+        page.public_version || page.versions.create!(public_on: public_on)
+      end
+    end
+  end
+end

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

@@ -29,7 +29,7 @@ module Alchemy
       def call
         if @page.language_root?
           language_root_path
-        elsif @site.languages.select(&:public?).length > 1
+        elsif @site.languages.count(&:public?) > 1
           page_path_with_language_prefix
         else
           page_path_with_leading_slash

data/app/models/alchemy/page_version.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module Alchemy
+  class PageVersion < BaseRecord
+    belongs_to :page, class_name: "Alchemy::Page", inverse_of: :versions
+
+    has_many :elements, -> { order(:position) },
+      class_name: "Alchemy::Element",
+      inverse_of: :page_version
+
+    scope :drafts, -> { where(public_on: nil).order(updated_at: :desc) }
+    scope :published, -> { where.not(public_on: nil).order(public_on: :desc) }
+
+    def self.public_on(time = Time.current)
+      where("#{table_name}.public_on <= :time AND " \
+            "(#{table_name}.public_until IS NULL " \
+            "OR #{table_name}.public_until >= :time)", time: time)
+    end
+
+    before_destroy :delete_elements
+
+    # Determines if this version is public
+    #
+    # Takes the two timestamps +public_on+ and +public_until+
+    # and returns true if the time given (+Time.current+ per default)
+    # is in this timespan.
+    #
+    # @param time [DateTime] (Time.current)
+    # @returns Boolean
+    def public?(time = Time.current)
+      already_public_for?(time) && still_public_for?(time)
+    end
+
+    # Determines if this version is already public for given time
+    # @param time [DateTime] (Time.current)
+    # @returns Boolean
+    def already_public_for?(time = Time.current)
+      !public_on.nil? && public_on <= time
+    end
+
+    # Determines if this version is still public for given time
+    # @param time [DateTime] (Time.current)
+    # @returns Boolean
+    def still_public_for?(time = Time.current)
+      public_until.nil? || public_until >= time
+    end
+
+    def element_repository
+      ElementsRepository.new(elements.includes({ contents: :essence }, :tags))
+    end
+
+    private
+
+    def delete_elements
+      DeleteElements.new(elements).call
+    end
+  end
+end

data/app/models/alchemy/picture.rb

@@ -86,7 +86,9 @@ module Alchemy
     dragonfly_accessor :image_file, app: :alchemy_pictures do
       # Preprocess after uploading the picture
       after_assign do |image|
-        self.class.preprocessor_class.new(image).call
+        if has_convertible_format?
+          self.class.preprocessor_class.new(image).call
+        end
       end
     end
 

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

@@ -27,15 +27,9 @@ module Alchemy
       # 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?
+      def sizes_from_string(string)
+        width, height = string.to_s.split("x", 2).map(&:to_i)
 
-        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,

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