alchemy_cms 5.2.1 → 6.0.0.pre.b4

data/app/models/alchemy/element.rb

@@ -7,7 +7,7 @@
 #  id                :integer          not null, primary key
 #  name              :string
 #  position          :integer
-#  page_id           :integer          not null
+#  page_version_id   :integer          not null
 #  public            :boolean          default(TRUE)
 #  fixed             :boolean          default(FALSE)
 #  folded            :boolean          default(FALSE)
@@ -20,6 +20,12 @@
 #  parent_element_id :integer
 #
 
+require_dependency "alchemy/element/definitions"
+require_dependency "alchemy/element/element_contents"
+require_dependency "alchemy/element/element_ingredients"
+require_dependency "alchemy/element/element_essences"
+require_dependency "alchemy/element/presenters"
+
 module Alchemy
   class Element < BaseRecord
     NAME_REGEXP = /\A[a-z0-9_-]+\z/
@@ -34,39 +40,31 @@ module Alchemy
       "nestable_elements",
       "contents",
       "hint",
+      "ingredients",
       "taggable",
       "compact",
       "message",
       "deprecated",
     ].freeze
 
-    SKIPPED_ATTRIBUTES_ON_COPY = [
-      "cached_tag_list",
-      "created_at",
-      "creator_id",
-      "id",
-      "folded",
-      "position",
-      "updated_at",
-      "updater_id",
-    ].freeze
-
-    # All Elements that share the same page id and parent element id and are fixed or not are considered a list.
+    # All Elements that share the same page version and parent element and are fixed or not are considered a list.
     #
-    # If parent element id is nil (typical case for a simple page),
+    # If parent_element_id is nil (typical case for a simple page),
     # then all elements on that page are still in one list,
     # because acts_as_list correctly creates this statement:
     #
-    #   WHERE page_id = 1 and fixed = FALSE AND parent_element_id = NULL
+    #   WHERE page_version_id = 1 and fixed = FALSE AND parent_element_id = NULL
     #
-    acts_as_list scope: [:page_id, :fixed, :parent_element_id]
+    acts_as_list scope: [:page_version_id, :fixed, :parent_element_id]
 
     stampable stamper_class_name: Alchemy.user_class_name
 
     has_many :contents, dependent: :destroy, inverse_of: :element
 
+    before_destroy :delete_all_nested_elements
+
     has_many :all_nested_elements,
-      -> { order(:position).not_trashed },
+      -> { order(:position) },
       class_name: "Alchemy::Element",
       foreign_key: :parent_element_id,
       dependent: :destroy
@@ -78,7 +76,8 @@ module Alchemy
       dependent: :destroy,
       inverse_of: :parent_element
 
-    belongs_to :page, touch: true, inverse_of: :elements
+    belongs_to :page_version, touch: true, inverse_of: :elements
+    has_one :page, through: :page_version
 
     # A nested element belongs to a parent element.
     belongs_to :parent_element,
@@ -101,11 +100,10 @@ module Alchemy
 
     after_update :touch_touchable_pages
 
-    scope :trashed, -> { where(position: nil).order("updated_at DESC") }
-    scope :not_trashed, -> { where.not(position: nil) }
     scope :published, -> { where(public: true) }
+    scope :hidden, -> { where(public: false) }
     scope :not_restricted, -> { joins(:page).merge(Page.not_restricted) }
-    scope :available, -> { published.not_trashed }
+    scope :available, -> { published }
     scope :named, ->(names) { where(name: names) }
     scope :excluded, ->(names) { where.not(name: names) }
     scope :fixed, -> { where(fixed: true) }
@@ -118,16 +116,14 @@ module Alchemy
     delegate :restricted?, to: :page, allow_nil: true
 
     # Concerns
-    include Alchemy::Element::Definitions
-    include Alchemy::Element::ElementContents
-    include Alchemy::Element::ElementEssences
-    include Alchemy::Element::Presenters
+    include Definitions
+    include ElementContents
+    include ElementEssences
+    include ElementIngredients
+    include Presenters
 
     # class methods
     class << self
-      deprecate :trashed, deprecator: Alchemy::Deprecation
-      deprecate :not_trashed, deprecator: Alchemy::Deprecation
-
       # Builds a new element as described in +/config/alchemy/elements.yml+
       #
       # - Returns a new Alchemy::Element object if no name is given in attributes,
@@ -159,26 +155,7 @@ module Alchemy
       #   @copy.public? # => false
       #
       def copy(source_element, differences = {})
-        attributes = source_element.attributes.with_indifferent_access
-          .except(*SKIPPED_ATTRIBUTES_ON_COPY)
-          .merge(differences)
-          .merge({
-            autogenerate_contents: false,
-            autogenerate_nested_elements: false,
-            tag_list: source_element.tag_list,
-          })
-
-        new_element = create!(attributes)
-
-        if source_element.contents.any?
-          source_element.copy_contents_to(new_element)
-        end
-
-        if source_element.nested_elements.any?
-          source_element.copy_nested_elements_to(new_element)
-        end
-
-        new_element
+        Alchemy::DuplicateElement.new(source_element).call(differences)
       end
 
       def all_from_clipboard(clipboard)
@@ -225,19 +202,6 @@ module Alchemy
       end
     end
 
-    # Trashing an element means nullifying its position, folding and unpublishing it.
-    def trash!
-      self.public = false
-      self.folded = true
-      remove_from_list
-    end
-    deprecate :trash!, deprecator: Alchemy::Deprecation
-
-    def trashed?
-      position.nil?
-    end
-    deprecate :trashed?, deprecator: Alchemy::Deprecation
-
     # Returns true if the definition of this element has a taggable true value.
     def taggable?
       definition["taggable"] == true
@@ -303,41 +267,17 @@ module Alchemy
       "alchemy/elements/#{name}"
     end
 
-    # Returns the key that's taken for cache path.
-    #
-    # Uses the page's +published_at+ value that's updated when the user publishes the page.
-    #
-    # If the page is the current preview it uses the element's updated_at value as cache key.
-    #
-    def cache_key
-      if Page.current_preview == page
-        "alchemy/elements/#{id}-#{updated_at}"
-      else
-        "alchemy/elements/#{id}-#{page.published_at}"
-      end
-    end
-
     # A collection of element names that can be nested inside this element.
     def nestable_elements
       definition.fetch("nestable_elements", [])
     end
 
-    # Copy all nested elements from current element to given target element.
-    def copy_nested_elements_to(target_element)
-      nested_elements.map do |nested_element|
-        Element.copy(nested_element, {
-          parent_element_id: target_element.id,
-          page_id: target_element.page_id,
-        })
-      end
-    end
-
     private
 
     def generate_nested_elements
       definition.fetch("autogenerate", []).each do |nestable_element|
         if nestable_elements.include?(nestable_element)
-          Element.create(page: page, parent_element_id: id, name: nestable_element)
+          Element.create(page_version: page_version, parent_element_id: id, name: nestable_element)
         else
           log_warning("Element '#{nestable_element}' not a nestable element for '#{name}'. Skipping!")
         end
@@ -358,5 +298,18 @@ module Alchemy
 
       touchable_pages.each(&:touch)
     end
+
+    def delete_all_nested_elements
+      deeply_nested_elements = descendent_elements(self).flatten
+      DeleteElements.new(deeply_nested_elements).call
+      nested_elements.reset
+      all_nested_elements.reset
+    end
+
+    def descendent_elements(element)
+      element.all_nested_elements + element.all_nested_elements.map do |nested_element|
+        descendent_elements(nested_element)
+      end
+    end
   end
 end

data/app/models/alchemy/elements_repository.rb

@@ -0,0 +1,126 @@
+# frozen_string_literal: true
+
+module Alchemy
+  # Mimics ActiveRecord query interface
+  # but does this on the preloaded elements
+  class ElementsRepository
+    include Enumerable
+
+    # An empty set of elements
+    def self.none
+      new([])
+    end
+
+    # @param [ActiveRecord::Relation]
+    def initialize(elements)
+      @elements = elements.to_a
+    end
+
+    # All visible elements
+    # @return [Alchemy::ElementRepository]
+    def visible
+      self.class.new select(&:public)
+    end
+
+    # All not fixed elements
+    # @return [Alchemy::ElementRepository]
+    def hidden
+      self.class.new reject(&:public)
+    end
+
+    # All elements with given name(s)
+    # @param [Array<String|Symbol>|String|Symbol]
+    # @return [Alchemy::ElementRepository]
+    def named(*names)
+      names.flatten!
+      self.class.new(select { |e| e.name.in?(names.map!(&:to_s)) })
+    end
+
+    # Filter elements by given attribute and value
+    # @param [Array|Hash]
+    # @return [Alchemy::ElementRepository]
+    def where(attrs)
+      self.class.new(
+        select do |element|
+          attrs.all? do |attr, value|
+            element.public_send(attr) == value
+          end
+        end
+      )
+    end
+
+    # All elements excluding those wth given name(s)
+    # @param [Array<String|Symbol>|String|Symbol]
+    # @return [Alchemy::ElementRepository]
+    def excluded(*names)
+      names.flatten!
+      self.class.new(reject { |e| e.name.in?(names.map!(&:to_s)) })
+    end
+
+    # All fixed elements
+    # @return [Alchemy::ElementRepository]
+    def fixed
+      self.class.new select(&:fixed)
+    end
+
+    # All not fixed elements
+    # @return [Alchemy::ElementRepository]
+    def unfixed
+      self.class.new reject(&:fixed)
+    end
+
+    # All folded elements
+    # @return [Alchemy::ElementRepository]
+    def folded
+      self.class.new select(&:folded)
+    end
+
+    # All expanded elements
+    # @return [Alchemy::ElementRepository]
+    def expanded
+      self.class.new reject(&:folded)
+    end
+
+    # All not nested top level elements
+    # @return [Alchemy::ElementRepository]
+    def not_nested
+      self.class.new(select { |e| e.parent_element_id.nil? })
+    end
+
+    # Elements in reversed order
+    # @return [Alchemy::ElementRepository]
+    def reverse
+      self.class.new elements.reverse
+    end
+
+    # Elements in random order
+    # @return [Alchemy::ElementRepository]
+    def random
+      self.class.new Array(elements).shuffle
+    end
+
+    # Elements off setted by
+    # @return [Alchemy::ElementRepository]
+    def offset(offset)
+      self.class.new elements[offset.to_i..-1]
+    end
+
+    # Elements limitted by
+    # @return [Alchemy::ElementRepository]
+    def limit(limit)
+      self.class.new elements[0..(limit.to_i - 1)]
+    end
+
+    def children_of(parent)
+      self.class.new(select { |e| e.parent_element_id == parent.id })
+    end
+
+    def each(&blk)
+      elements.each(&blk)
+    end
+
+    private
+
+    attr_reader :elements
+  end
+end

data/app/models/alchemy/essence_audio.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Alchemy
+  class EssenceAudio < ActiveRecord::Base
+    acts_as_essence(
+      ingredient_column: :attachment,
+      preview_text_method: :name,
+    )
+
+    belongs_to :attachment, optional: true
+  end
+end

data/app/models/alchemy/essence_headline.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Alchemy
+  class EssenceHeadline < BaseRecord
+    acts_as_essence
+
+    after_initialize :set_level_and_size
+
+    def preview_text(maxlength = 30)
+      "H#{level}: #{body}"[0..maxlength - 1]
+    end
+
+    def level_options
+      levels.map { |level| ["H#{level}", level] }
+    end
+
+    def size_options
+      sizes.map { |size| ["H#{size}", size] }
+    end
+
+    private
+
+    def content_settings
+      content&.settings || {}
+    end
+
+    def levels
+      content_settings.fetch(:levels, (1..6))
+    end
+
+    def sizes
+      content_settings.fetch(:sizes, [])
+    end
+
+    def set_level_and_size
+      self.level ||= levels.first
+      self.size ||= sizes.first
+    end
+  end
+end

data/app/models/alchemy/essence_picture.rb

@@ -23,6 +23,8 @@
 
 module Alchemy
   class EssencePicture < BaseRecord
+    include Alchemy::PictureThumbnails
+
     acts_as_essence ingredient_column: :picture, belongs_to: {
       class_name: "Alchemy::Picture",
       foreign_key: :picture_id,
@@ -30,81 +32,9 @@ module Alchemy
       optional: true,
     }
 
-    delegate :image_file_width, :image_file_height, :image_file, to: :picture
-    before_save :fix_crop_values
-    before_save :replace_newlines
-
-    include Alchemy::Picture::Transformations
-
-    # 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
+    delegate :settings, to: :content
 
-    # 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?
-
-      {
-        format: picture.default_render_format,
-        crop_from: crop_from.presence,
-        crop_size: crop_size.presence,
-        size: content.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?
-
-      crop = crop_values_present? || content.settings[:crop]
-      size = render_size || content.settings[:size]
-
-      options = {
-        size: thumbnail_size(size, crop),
-        crop: !!crop,
-        crop_from: crop_from.presence,
-        crop_size: crop_size.presence,
-        flatten: true,
-        format: picture.image_file_format,
-      }
-
-      picture.url(options) || "alchemy/missing-image.svg"
-    end
+    before_save :replace_newlines
 
     # The name of the picture used as preview text in element editor views.
     #
@@ -118,18 +48,6 @@ module Alchemy
       picture.name.to_s[0..max - 1]
     end
 
-    # A Hash of coordinates suitable for the graphical image cropper.
-    #
-    # @return [Hash]
-    def cropping_mask
-      return if crop_from.blank? || crop_size.blank?
-
-      crop_from = point_from_string(read_attribute(:crop_from))
-      crop_size = sizes_from_string(read_attribute(:crop_size))
-
-      point_and_mask_to_points(crop_from, crop_size)
-    end
-
     # Returns a serialized ingredient value for json api
     #
     # @return [String]
@@ -137,38 +55,8 @@ module Alchemy
       picture_url(content.settings)
     end
 
-    # Show image cropping link for content
-    def allow_image_cropping?
-      content && content.settings[:crop] && picture &&
-        picture.can_be_cropped_to?(
-          content.settings[:size],
-          content.settings[:upsample],
-        ) && !!picture.image_file
-    end
-
-    def crop_values_present?
-      crop_from.present? && crop_size.present?
-    end
-
     private
 
-    def fix_crop_values
-      %i(crop_from crop_size).each do |crop_value|
-        if self[crop_value].is_a?(String)
-          write_attribute crop_value, normalize_crop_value(crop_value)
-        end
-      end
-    end
-
-    def normalize_crop_value(crop_value)
-      self[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
-
     def replace_newlines
       return nil if caption.nil?