alchemy_cms 4.6.1 → 5.0.0.beta1

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

data/app/models/alchemy/element/definitions.rb

@@ -19,7 +19,7 @@ module Alchemy
       # Returns one element definition by given name.
       #
       def definition_by_name(name)
-        definitions.detect { |d| d['name'] == name }
+        definitions.detect { |d| d["name"] == name }
       end
 
       private
@@ -30,21 +30,21 @@ module Alchemy
         if ::File.exist?(definitions_file_path)
           ::YAML.safe_load(ERB.new(File.read(definitions_file_path)).result, YAML_WHITELIST_CLASSES, [], true) || []
         else
-          raise LoadError, "Could not find elements.yml file! Please run `rails generate alchemy:scaffold`"
+          raise LoadError, "Could not find elements.yml file! Please run `rails generate alchemy:install`"
         end
       end
 
       # Returns the +elements.yml+ file path
       #
       def definitions_file_path
-        Rails.root.join 'config/alchemy/elements.yml'
+        Rails.root.join "config/alchemy/elements.yml"
       end
     end
 
     # The definition of this element.
     #
     def definition
-      if definition = self.class.definitions.detect { |d| d['name'] == name }
+      if definition = self.class.definitions.detect { |d| d["name"] == name }
         definition
       else
         log_warning "Could not find element definition for #{name}. Please check your elements.yml file!"

data/app/models/alchemy/element/element_contents.rb

@@ -47,6 +47,7 @@ module Alchemy
     #
     def update_contents(contents_attributes)
       return true if contents_attributes.nil?
+
       contents.each do |content|
         content_hash = contents_attributes[content.id.to_s] || next
         content.update_essence(content_hash) || errors.add(:base, :essence_validation_failed)
@@ -72,7 +73,7 @@ module Alchemy
     #       rss_title: true
     #
     def content_for_rss_title
-      content_for_rss_meta('title')
+      content_for_rss_meta("title")
     end
 
     # Returns the content that is marked as rss description.
@@ -86,13 +87,14 @@ module Alchemy
     #       rss_description: true
     #
     def content_for_rss_description
-      content_for_rss_meta('description')
+      content_for_rss_meta("description")
     end
 
     # Returns the array with the hashes for all element contents in the elements.yml file
     def content_definitions
       return nil if definition.blank?
-      definition['contents']
+
+      definition["contents"]
     end
 
     # Returns the definition for given content_name
@@ -101,7 +103,7 @@ module Alchemy
         log_warning "Element #{name} is missing the content definition for #{content_name}"
         nil
       else
-        content_definitions.detect { |d| d['name'] == content_name.to_s }
+        content_definitions.detect { |d| d["name"] == content_name.to_s }
       end
     end
 
@@ -136,12 +138,13 @@ module Alchemy
     def content_for_rss_meta(type)
       definition = content_definitions.detect { |c| c["rss_#{type}"] }
       return if definition.blank?
-      contents.detect { |content| content.name == definition['name'] }
+
+      contents.detect { |content| content.name == definition["name"] }
     end
 
     # creates the contents for this element as described in the elements.yml
     def create_contents
-      definition.fetch('contents', []).each do |attributes|
+      definition.fetch("contents", []).each do |attributes|
         Content.create(attributes.merge(element: self))
       end
     end

data/app/models/alchemy/element/element_essences.rb

@@ -6,6 +6,7 @@ module Alchemy
     def ingredient(name)
       content = content_by_name(name)
       return nil if content.blank?
+
       content.ingredient
     end
 
@@ -96,12 +97,12 @@ module Alchemy
         errors.each do |error|
           messages << Alchemy.t(
             "#{name}.#{content_name}.#{error}",
-            scope: 'content_validations',
+            scope: "content_validations",
             default: [
               "fields.#{content_name}.#{error}".to_sym,
-              "errors.#{error}".to_sym
+              "errors.#{error}".to_sym,
             ],
-            field: Content.translated_label_for(content_name, name)
+            field: Content.translated_label_for(content_name, name),
           )
         end
       end