alchemy_cms 4.6.0 → 5.0.0.rc2

data/app/helpers/alchemy/url_helper.rb

@@ -18,7 +18,8 @@ module Alchemy
 
     # Returns the correct params-hash for passing to show_page_path
     def show_page_path_params(page, optional_params = {})
-      raise ArgumentError, 'Page is nil' if page.nil?
+      raise ArgumentError, "Page is nil" if page.nil?
+
       url_params = {urlname: page.urlname}.update(optional_params)
       prefix_locale? ? url_params.update(locale: page.language_code) : url_params
     end

data/app/mailers/alchemy/base_mailer.rb

@@ -2,7 +2,7 @@
 
 module Alchemy
   begin
-    base_class = Object.const_get('::ApplicationMailer')
+    base_class = Object.const_get("::ApplicationMailer")
   rescue NameError
     base_class = ActionMailer::Base
   end

data/app/mailers/alchemy/messages_mailer.rb

@@ -8,7 +8,7 @@ module Alchemy
         from: mail_from,
         to: mail_to,
         reply_to: message.try(:email),
-        subject: subject
+        subject: subject,
       )
     end
   end

data/app/models/alchemy/attachment.rb

@@ -22,7 +22,7 @@ module Alchemy
     include Alchemy::Filetypes
     include Alchemy::NameConversions
     include Alchemy::Taggable
-    include Alchemy::ContentTouching
+    include Alchemy::TouchElements
 
     dragonfly_accessor :file, app: :alchemy_attachments do
       after_assign { |f| write_attribute(:file_mime_type, f.mime_type) }
@@ -30,7 +30,7 @@ module Alchemy
 
     stampable stamper_class_name: Alchemy.user_class_name
 
-    has_many :essence_files, class_name: 'Alchemy::EssenceFile', foreign_key: 'attachment_id'
+    has_many :essence_files, class_name: "Alchemy::EssenceFile", foreign_key: "attachment_id"
     has_many :contents, through: :essence_files
     has_many :elements, through: :contents
     has_many :pages, through: :elements
@@ -42,24 +42,25 @@ module Alchemy
       end
 
       def allowed_filetypes
-        Config.get(:uploader).fetch('allowed_filetypes', {}).fetch('alchemy/attachments', [])
+        Config.get(:uploader).fetch("allowed_filetypes", {}).fetch("alchemy/attachments", [])
       end
 
       def file_types_for_select
         file_types = Alchemy::Attachment.pluck(:file_mime_type).uniq.map do |type|
-          [Alchemy.t(type, scope: 'mime_types'), type]
+          [Alchemy.t(type, scope: "mime_types"), type]
         end
         file_types.sort_by(&:first)
       end
     end
 
     validates_presence_of :file
-    validates_size_of :file, maximum: Config.get(:uploader)['file_size_limit'].megabytes
-    validates_property :ext, of: :file,
+    validates_size_of :file, maximum: Config.get(:uploader)["file_size_limit"].megabytes
+    validates_property :ext,
+      of: :file,
       in: allowed_filetypes,
       case_sensitive: false,
       message: Alchemy.t("not a valid file"),
-      unless: -> { self.class.allowed_filetypes.include?('*') }
+      unless: -> { self.class.allowed_filetypes.include?("*") }
 
     before_save :set_name, if: :file_name_changed?
 
@@ -71,13 +72,13 @@ module Alchemy
       {
         "name" => read_attribute(:file_name),
         "size" => read_attribute(:file_size),
-        'error' => errors[:file].join
+        "error" => errors[:file].join,
       }
     end
 
     # An url save filename without format suffix
     def urlname
-      CGI.escape(file_name.gsub(/\.#{extension}$/, '').tr('.', ' '))
+      CGI.escape(file_name.gsub(/\.#{extension}$/, "").tr(".", " "))
     end
 
     # Checks if the attachment is restricted, because it is attached on restricted pages only
@@ -89,6 +90,7 @@ module Alchemy
     def extension
       file_name.split(".").last
     end
+
     alias_method :suffix, :extension
 
     # Returns a css class name for kind of file
@@ -96,23 +98,23 @@ module Alchemy
     def icon_css_class
       case file_mime_type
       when "application/pdf"
-        then "file-pdf"
+        "file-pdf"
       when "application/msword"
-        then "file-word"
+        "file-word"
       when *TEXT_FILE_TYPES
-        then "file-alt"
+        "file-alt"
       when *EXCEL_FILE_TYPES
-        then "file-excel"
+        "file-excel"
       when *VCARD_FILE_TYPES
-        then "address-card"
+        "address-card"
       when *ARCHIVE_FILE_TYPES
-        then "file-archive"
+        "file-archive"
       when *AUDIO_FILE_TYPES
-        then "file-audio"
+        "file-audio"
       when *IMAGE_FILE_TYPES
-        then "file-image"
+        "file-image"
       when *VIDEO_FILE_TYPES
-        then "file-video"
+        "file-video"
       else
         "file"
       end

data/app/models/alchemy/base_record.rb

@@ -1,13 +1,10 @@
+# frozen_string_literal: true
 module Alchemy
   def self.table_name_prefix
-    'alchemy_'
+    "alchemy_"
   end
 
   class BaseRecord < ActiveRecord::Base
     self.abstract_class = true
-
-    def active_record_5_1?
-      ActiveRecord.gem_version >= Gem::Version.new('5.1.0')
-    end
   end
 end

data/app/models/alchemy/content.rb

@@ -28,29 +28,25 @@ module Alchemy
     belongs_to :element, touch: true, inverse_of: :contents
     has_one :page, through: :element
 
-    stampable stamper_class_name: Alchemy.user_class_name
-
-    acts_as_list scope: [:element_id]
-
     # Essence scopes
-    scope :essence_booleans,  -> { where(essence_type: "Alchemy::EssenceBoolean") }
-    scope :essence_dates,     -> { where(essence_type: "Alchemy::EssenceDate") }
-    scope :essence_files,     -> { where(essence_type: "Alchemy::EssenceFile") }
-    scope :essence_htmls,     -> { where(essence_type: "Alchemy::EssenceHtml") }
-    scope :essence_links,     -> { where(essence_type: "Alchemy::EssenceLink") }
-    scope :essence_pictures,  -> { where(essence_type: "Alchemy::EssencePicture") }
+    scope :essence_booleans, -> { where(essence_type: "Alchemy::EssenceBoolean") }
+    scope :essence_dates, -> { where(essence_type: "Alchemy::EssenceDate") }
+    scope :essence_files, -> { where(essence_type: "Alchemy::EssenceFile") }
+    scope :essence_htmls, -> { where(essence_type: "Alchemy::EssenceHtml") }
+    scope :essence_links, -> { where(essence_type: "Alchemy::EssenceLink") }
+    scope :essence_pictures, -> { where(essence_type: "Alchemy::EssencePicture") }
     scope :essence_richtexts, -> { where(essence_type: "Alchemy::EssenceRichtext") }
-    scope :essence_selects,   -> { where(essence_type: "Alchemy::EssenceSelect") }
-    scope :essence_texts,     -> { where(essence_type: "Alchemy::EssenceText") }
-    scope :named,             ->(name) { where(name: name) }
-    scope :available,         -> { published.not_trashed }
-    scope :published,         -> { joins(:element).merge(Element.published) }
-    scope :not_trashed,       -> { joins(:element).merge(Element.not_trashed) }
-    scope :not_restricted,    -> { joins(:element).merge(Element.not_restricted) }
-
-    delegate :restricted?, to: :page,    allow_nil: true
-    delegate :trashed?,    to: :element, allow_nil: true
-    delegate :public?,     to: :element, allow_nil: true
+    scope :essence_selects, -> { where(essence_type: "Alchemy::EssenceSelect") }
+    scope :essence_texts, -> { where(essence_type: "Alchemy::EssenceText") }
+    scope :named, ->(name) { where(name: name) }
+    scope :available, -> { published.not_trashed }
+    scope :published, -> { joins(:element).merge(Element.published) }
+    scope :not_trashed, -> { joins(:element).merge(Element.not_trashed) }
+    scope :not_restricted, -> { joins(:element).merge(Element.not_restricted) }
+
+    delegate :restricted?, to: :page, allow_nil: true
+    delegate :trashed?, to: :element, allow_nil: true
+    delegate :public?, to: :element, allow_nil: true
 
     class << self
       # Returns the translated label for a content name.
@@ -72,7 +68,7 @@ module Alchemy
         Alchemy.t(
           content_name,
           scope: "content_names.#{element_name}",
-          default: Alchemy.t("content_names.#{content_name}", default: content_name.humanize)
+          default: Alchemy.t("content_names.#{content_name}", default: content_name.humanize),
         )
       end
     end
@@ -99,6 +95,7 @@ module Alchemy
     # Settings from the elements.yml definition
     def settings
       return {} if definition.blank?
+
       @settings ||= definition.fetch(:settings, {})
     end
 
@@ -114,12 +111,14 @@ module Alchemy
 
     def siblings
       return [] if !element
+
       element.contents
     end
 
     # Gets the ingredient from essence
     def ingredient
       return nil if essence.nil?
+
       essence.ingredient
     end
 
@@ -129,7 +128,7 @@ module Alchemy
       {
         name: name,
         value: serialized_ingredient,
-        link: essence.try(:link)
+        link: essence.try(:link),
       }.delete_if { |_k, v| v.blank? }
     end
 
@@ -145,6 +144,7 @@ module Alchemy
     # Sets the ingredient from essence
     def ingredient=(value)
       raise EssenceMissingError if essence.nil?
+
       essence.ingredient = value
     end
 
@@ -156,11 +156,12 @@ module Alchemy
     #
     def update_essence(params = {})
       raise EssenceMissingError if essence.nil?
+
       if essence.update(params)
-        return true
+        true
       else
         errors.add(:essence, :validation_failed)
-        return false
+        false
       end
     end
 
@@ -169,12 +170,13 @@ module Alchemy
     end
 
     def has_validations?
-      definition['validate'].present?
+      definition["validate"].present?
     end
 
     # Returns a string used as dom id on html elements.
     def dom_id
-      return '' if essence.nil?
+      return "" if essence.nil?
+
       "#{essence_partial_name}_#{id}"
     end
 
@@ -189,7 +191,7 @@ module Alchemy
 
     # Returns true if this content should be taken for element preview.
     def preview_content?
-      !!definition['as_element_title']
+      !!definition["as_element_title"]
     end
 
     # Proxy method that returns the preview text from essence.
@@ -199,7 +201,8 @@ module Alchemy
     end
 
     def essence_partial_name
-      return '' if essence.nil?
+      return "" if essence.nil?
+
       essence.partial_name
     end
 
@@ -223,19 +226,11 @@ module Alchemy
       "has_tinymce" + (has_custom_tinymce_config? ? " #{element.name}_#{name}" : "")
     end
 
-    def editor
-      @_editor ||= ContentEditor.new(self)
-    end
-    delegate :form_field_name, to: :editor
-    deprecate form_field_name: "use Alchemy::ContentEditor#form_field_name instead", deprecator: Alchemy::Deprecation
-    delegate :form_field_id, to: :editor
-    deprecate form_field_id: "use Alchemy::ContentEditor#form_field_id instead", deprecator: Alchemy::Deprecation
-
     # Returns the default value from content definition
     #
     # If the value is a symbol it gets passed through i18n
     # inside the +alchemy.default_content_texts+ scope
-    def default_text(default)
+    def default_value(default = definition[:default])
       case default
       when Symbol
         Alchemy.t(default, scope: :default_content_texts)

data/app/models/alchemy/content/factory.rb

@@ -22,10 +22,13 @@ module Alchemy
         if definition.blank?
           raise ContentDefinitionError, "No definition found in elements.yml for #{attributes.inspect} and #{element.inspect}"
         end
-        super(name: definition['name'], element_id: element.id)
+
+        super(
+          name: definition[:name],
+          essence_type: normalize_essence_type(definition[:type]),
+          element_id: element.id
+        ).tap(&:build_essence)
       end
-      alias_method :build, :new
-      deprecate build: :new, deprecator: Alchemy::Deprecation
 
       # Creates a new content from elements definition in the +elements.yml+ file.
       #
@@ -34,20 +37,11 @@ module Alchemy
       #
       # @return [Alchemy::Content]
       #
-      def create(*args)
-        attributes = args.last || {}
-        if args.length > 1
-          Alchemy::Deprecation.warn 'Passing an element as first argument to Alchemy::Content.create is deprecated! Pass an attribute hash with element inside instead.'
-          element = args.first
-        else
-          element = attributes[:element]
-        end
-        new(attributes.merge(element: element)).tap do |content|
-          content.create_essence!(attributes[:essence_type])
+      def create(attributes = {})
+        new(attributes).tap do |content|
+          content.essence.save && content.save
         end
       end
-      alias_method :create_from_scratch, :create
-      deprecate create_from_scratch: :create, deprecator: Alchemy::Deprecation
 
       # Creates a copy of source and also copies the associated essence.
       #
@@ -62,11 +56,11 @@ module Alchemy
         new_content = Content.new(
           source.attributes.
             except(*SKIPPED_ATTRIBUTES_ON_COPY).
-            merge(differences.with_indifferent_access)
+            merge(differences.with_indifferent_access),
         )
         new_essence = source.essence.class.create!(
           source.essence.attributes.
-            except(*SKIPPED_ATTRIBUTES_ON_COPY)
+            except(*SKIPPED_ATTRIBUTES_ON_COPY),
         )
         new_content.tap do |content|
           content.essence = new_essence
@@ -77,7 +71,7 @@ module Alchemy
       # Returns all content definitions from elements.yml
       #
       def definitions
-        definitions = Element.definitions.flat_map { |e| e['contents'] }
+        definitions = Element.definitions.flat_map { |e| e["contents"] }
         definitions.compact!
         definitions
       end
@@ -119,12 +113,22 @@ module Alchemy
       element.content_definition_for(name) || {}
     end
 
+    # Build essence from definition.
+    #
+    # If an optional type is passed, this type of essence gets created.
+    #
+    def build_essence(type = essence_type)
+      self.essence = essence_class(type).new({
+        ingredient: default_value,
+      })
+    end
+
     # Creates essence from definition.
     #
     # If an optional type is passed, this type of essence gets created.
     #
     def create_essence!(type = nil)
-      self.essence = essence_class(type).create!(prepared_attributes_for_essence)
+      build_essence(type).save!
       save!
     end
 
@@ -135,18 +139,7 @@ module Alchemy
     # If an optional type is passed, this type of essence gets constantized.
     #
     def essence_class(type = nil)
-      Content.normalize_essence_type(type || definition['type']).constantize
-    end
-
-    # Prepares the attributes for creating the essence.
-    #
-    # 1. It sets a default text if given in +elements.yml+
-    #
-    def prepared_attributes_for_essence
-      attributes = {
-        ingredient: default_text(definition['default'])
-      }
-      attributes
+      Content.normalize_essence_type(type || definition["type"]).constantize
     end
   end
 end

data/app/models/alchemy/element.rb

@@ -22,6 +22,8 @@
 
 module Alchemy
   class Element < BaseRecord
+    NAME_REGEXP = /\A[a-z0-9_-]+\z/
+
     include Alchemy::Logger
     include Alchemy::Taggable
     include Alchemy::Hints
@@ -34,7 +36,7 @@ module Alchemy
       "hint",
       "taggable",
       "compact",
-      "message"
+      "message",
     ].freeze
 
     SKIPPED_ATTRIBUTES_ON_COPY = [
@@ -45,7 +47,7 @@ module Alchemy
       "folded",
       "position",
       "updated_at",
-      "updater_id"
+      "updater_id",
     ].freeze
 
     # All Elements that share the same page id and parent element id and are fixed or not are considered a list.
@@ -60,17 +62,17 @@ module Alchemy
 
     stampable stamper_class_name: Alchemy.user_class_name
 
-    has_many :contents, -> { order(:position) }, dependent: :destroy, inverse_of: :element
+    has_many :contents, dependent: :destroy, inverse_of: :element
 
     has_many :all_nested_elements,
       -> { order(:position).not_trashed },
-      class_name: 'Alchemy::Element',
+      class_name: "Alchemy::Element",
       foreign_key: :parent_element_id,
       dependent: :destroy
 
     has_many :nested_elements,
       -> { order(:position).available },
-      class_name: 'Alchemy::Element',
+      class_name: "Alchemy::Element",
       foreign_key: :parent_element_id,
       dependent: :destroy,
       inverse_of: :parent_element
@@ -79,17 +81,17 @@ module Alchemy
 
     # A nested element belongs to a parent element.
     belongs_to :parent_element,
-      class_name: 'Alchemy::Element',
+      class_name: "Alchemy::Element",
       optional: true,
       touch: true,
       inverse_of: :nested_elements
 
     has_and_belongs_to_many :touchable_pages, -> { distinct },
-      class_name: 'Alchemy::Page',
+      class_name: "Alchemy::Page",
       join_table: ElementToPage.table_name
 
     validates_presence_of :name, on: :create
-    validates_format_of :name, on: :create, with: /\A[a-z0-9_-]+\z/
+    validates_format_of :name, on: :create, with: NAME_REGEXP
 
     attr_accessor :autogenerate_contents
     attr_accessor :autogenerate_nested_elements
@@ -98,19 +100,19 @@ 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 :not_restricted,    -> { joins(:page).merge(Page.not_restricted) }
-    scope :available,         -> { published.not_trashed }
-    scope :named,             ->(names) { where(name: names) }
-    scope :excluded,          ->(names) { where.not(name: names) }
-    scope :fixed,             -> { where(fixed: true) }
-    scope :unfixed,           -> { where(fixed: false) }
-    scope :from_current_site, -> { where(Language.table_name => {site_id: Site.current || Site.default}).joins(page: 'language') }
-    scope :folded,            -> { where(folded: true) }
-    scope :expanded,          -> { where(folded: false) }
-    scope :not_nested,        -> { where(parent_element_id: nil) }
+    scope :trashed, -> { where(position: nil).order("updated_at DESC") }
+    scope :not_trashed, -> { where.not(position: nil) }
+    scope :published, -> { where(public: true) }
+    scope :not_restricted, -> { joins(:page).merge(Page.not_restricted) }
+    scope :available, -> { published.not_trashed }
+    scope :named, ->(names) { where(name: names) }
+    scope :excluded, ->(names) { where.not(name: names) }
+    scope :fixed, -> { where(fixed: true) }
+    scope :unfixed, -> { where(fixed: false) }
+    scope :from_current_site, -> { where(Language.table_name => { site_id: Site.current || Site.default }).joins(page: "language") }
+    scope :folded, -> { where(folded: true) }
+    scope :expanded, -> { where(folded: false) }
+    scope :not_nested, -> { where(parent_element_id: nil) }
 
     delegate :restricted?, to: :page, allow_nil: true
 
@@ -131,7 +133,8 @@ module Alchemy
       #
       def new(attributes = {})
         return super if attributes[:name].blank?
-        element_attributes = attributes.to_h.merge(name: attributes[:name].split('#').first)
+
+        element_attributes = attributes.to_h.merge(name: attributes[:name].split("#").first)
         element_definition = Element.definition_by_name(element_attributes[:name])
         if element_definition.nil?
           raise(ElementDefinitionError, attributes)
@@ -139,11 +142,6 @@ module Alchemy
 
         super(element_definition.merge(element_attributes).except(*FORBIDDEN_DEFINITION_ATTRIBUTES))
       end
-      alias_method :new_from_scratch, :new
-      deprecate new_from_scratch: :new, deprecator: Alchemy::Deprecation
-
-      alias_method :create_from_scratch, :create
-      deprecate create_from_scratch: :create, deprecator: Alchemy::Deprecation
 
       # This methods does a copy of source and all depending contents and all of their depending essences.
       #
@@ -158,13 +156,13 @@ module Alchemy
       #
       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
-                       })
+          .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)
 
@@ -181,13 +179,15 @@ module Alchemy
 
       def all_from_clipboard(clipboard)
         return [] if clipboard.nil?
-        where(id: clipboard.collect { |e| e['id'] })
+
+        where(id: clipboard.collect { |e| e["id"] })
       end
 
       # All elements in clipboard that could be placed on page
       #
       def all_from_clipboard_for_page(clipboard, page)
         return [] if clipboard.nil? || page.nil?
+
         all_from_clipboard(clipboard).select { |ce|
           page.available_element_names.include?(ce.name)
         }
@@ -199,7 +199,7 @@ module Alchemy
     # Pass an element name to get next of this kind.
     #
     def next(name = nil)
-      elements = page.elements.published.where('position > ?', position)
+      elements = page.elements.published.where("position > ?", position)
       select_element(elements, name, :asc)
     end
 
@@ -208,13 +208,14 @@ module Alchemy
     # Pass an element name to get previous of this kind.
     #
     def prev(name = nil)
-      elements = page.elements.published.where('position < ?', position)
+      elements = page.elements.published.where("position < ?", position)
       select_element(elements, name, :desc)
     end
 
     # Stores the page into +touchable_pages+ (Pages that have to be touched after updating the element).
     def store_page(page)
       return true if page.nil?
+
       unless touchable_pages.include? page
         touchable_pages << page
       end
@@ -233,7 +234,7 @@ module Alchemy
 
     # Returns true if the definition of this element has a taggable true value.
     def taggable?
-      definition['taggable'] == true
+      definition["taggable"] == true
     end
 
     # The opposite of folded?
@@ -243,7 +244,7 @@ module Alchemy
 
     # Defined as compact element?
     def compact?
-      definition['compact'] == true
+      definition["compact"] == true
     end
 
     # The element's view partial is dependent from its name
@@ -261,17 +262,7 @@ module Alchemy
     # Element partials live in +app/views/alchemy/elements+
     #
     def to_partial_path
-      if Alchemy::LOOKUP_CONTEXT.exists?("#{name}_view", ["elements"], true)
-        Alchemy::Deprecation.warn <<~WARN
-          Having the `_view` suffix on your element view partials is deprecated
-          and will not be supported in Alchemy 5.0 anymore. You can safely remove the suffix now.
-
-          Please also rename the local `element` or `#{name}_view` variable into `#{name}`.
-        WARN
-        "alchemy/elements/#{name}_view"
-      else
-        "alchemy/elements/#{name}"
-      end
+      "alchemy/elements/#{name}"
     end
 
     # Returns the key that's taken for cache path.
@@ -290,7 +281,7 @@ module Alchemy
 
     # A collection of element names that can be nested inside this element.
     def nestable_elements
-      definition.fetch('nestable_elements', [])
+      definition.fetch("nestable_elements", [])
     end
 
     # Copy all nested elements from current element to given target element.
@@ -298,7 +289,7 @@ module Alchemy
       nested_elements.map do |nested_element|
         Element.copy(nested_element, {
           parent_element_id: target_element.id,
-          page_id: target_element.page_id
+          page_id: target_element.page_id,
         })
       end
     end
@@ -306,7 +297,7 @@ module Alchemy
     private
 
     def generate_nested_elements
-      definition.fetch('autogenerate', []).each do |nestable_element|
+      definition.fetch("autogenerate", []).each do |nestable_element|
         if nestable_elements.include?(nestable_element)
           Element.create(page: page, parent_element_id: id, name: nestable_element)
         else
@@ -326,6 +317,7 @@ module Alchemy
     #
     def touch_touchable_pages
       return unless respond_to?(:touchable_pages)
+
       touchable_pages.each(&:touch)
     end
   end