alchemy_cms 6.0.0.pre.rc6 → 6.0.1

data/lib/alchemy/essence.rb

@@ -3,18 +3,6 @@
 require "active_record"
 
 module Alchemy #:nodoc:
-  # A bogus association that skips eager loading for essences not having an ingredient association
-  class IngredientAssociation < ActiveRecord::Associations::BelongsToAssociation
-    # Skip eager loading if called by Rails' preloader
-    def klass
-      if caller.any? { |line| line =~ /preloader\.rb/ }
-        nil
-      else
-        super
-      end
-    end
-  end
-
   module Essence #:nodoc:
     def self.included(base)
       base.extend(ClassMethods)
@@ -43,8 +31,6 @@ module Alchemy #:nodoc:
           ingredient_column: "body",
         }.update(options)
 
-        @_classes_with_ingredient_association ||= []
-
         class_eval <<-RUBY, __FILE__, __LINE__ + 1
           attr_writer :validation_errors
           include Alchemy::Essence::InstanceMethods
@@ -55,7 +41,7 @@ module Alchemy #:nodoc:
           has_one :element, through: :content, class_name: "Alchemy::Element"
           has_one :page,    through: :element, class_name: "Alchemy::Page"
 
-          scope :available,    -> { joins(:element).merge(Alchemy::Element.available) }
+          scope :available,    -> { joins(:element).merge(Alchemy::Element.published) }
           scope :from_element, ->(name) { joins(:element).where(Element.table_name => { name: name }) }
 
           delegate :restricted?, to: :page,    allow_nil: true
@@ -87,18 +73,6 @@ module Alchemy #:nodoc:
             alias_method :#{configuration[:ingredient_column]}, :ingredient_association
             alias_method :#{configuration[:ingredient_column]}=, :ingredient_association=
           RUBY
-
-          @_classes_with_ingredient_association << self
-        end
-      end
-
-      # Overwrite ActiveRecords method to return a bogus association class that skips eager loading
-      # for essence classes that do not have an ingredient association
-      def _reflect_on_association(name)
-        if name == :ingredient_association && !in?(@_classes_with_ingredient_association)
-          OpenStruct.new(association_class: Alchemy::IngredientAssociation)
-        else
-          super
         end
       end
 

data/lib/alchemy/page_layout.rb

@@ -151,7 +151,11 @@ module Alchemy
       #
       def read_definitions_file
         if File.exist?(layouts_file_path)
-          YAML.safe_load(ERB.new(File.read(layouts_file_path)).result, YAML_WHITELIST_CLASSES, [], true) || []
+          YAML.safe_load(
+            ERB.new(File.read(layouts_file_path)).result,
+            permitted_classes: YAML_PERMITTED_CLASSES,
+            aliases: true,
+          ) || []
         else
           raise LoadError, "Could not find page_layouts.yml file! Please run `rails generate alchemy:install`"
         end

data/lib/alchemy/permissions.rb

@@ -41,7 +41,7 @@ module Alchemy
           c.public? && !c.restricted?
         end
 
-        can :read, Alchemy::Element, Alchemy::Element.available.not_restricted do |e|
+        can :read, Alchemy::Element, Alchemy::Element.published.not_restricted do |e|
           e.public? && !e.restricted?
         end
 
@@ -68,7 +68,7 @@ module Alchemy
           c.public?
         end
 
-        can :read, Alchemy::Element, Alchemy::Element.available do |e|
+        can :read, Alchemy::Element, Alchemy::Element.published do |e|
           e.public?
         end
 
@@ -147,7 +147,6 @@ module Alchemy
           :copy_language_tree,
           :flush,
           :order,
-          :sort,
           :switch_language,
         ], Alchemy::Page
 

data/lib/alchemy/resource.rb

@@ -169,10 +169,25 @@ module Alchemy
           name: col.name,
           type: resource_column_type(col),
           relation: resource_relation(col.name),
-        }.delete_if { |_k, v| v.nil? }
+          enum: enum_values_collection_for_select(col.name),
+        }.delete_if { |_k, v| v.blank? }
       end.compact
     end
 
+    def enum_values_collection_for_select(column_name)
+      enum = model.defined_enums[column_name]
+      return if enum.blank?
+
+      enum.keys.map do |key|
+        [
+          ::I18n.t(key, scope: [
+            :activerecord, :attributes, model.model_name.i18n_key, "#{column_name}_values"
+          ], default: key.humanize),
+          key,
+        ]
+      end
+    end
+
     def sorted_attributes
       @_sorted_attributes ||= attributes.
         sort_by  { |attr| attr[:name] == "name" ? 0 : 1 }.

data/lib/alchemy/test_support/essence_shared_examples.rb

@@ -7,18 +7,6 @@ RSpec.shared_examples_for "an essence" do
   let(:content) { Alchemy::Content.new(name: "foo") }
   let(:content_definition) { { "name" => "foo" } }
 
-  describe "eager loading" do
-    before do
-      2.times { described_class.create! }
-    end
-
-    it "does not throw error if eager loaded" do
-      expect {
-        described_class.all.includes(:ingredient_association).to_a
-      }.to_not raise_error
-    end
-  end
-
   it "touches the element after save" do
     element = FactoryBot.create(:alchemy_element)
     content = FactoryBot.create(:alchemy_content, element: element, essence: essence, essence_type: essence.class.name)

data/lib/alchemy/test_support/shared_ingredient_examples.rb

@@ -28,7 +28,7 @@ RSpec.shared_examples_for "an alchemy ingredient" do
 
     context "with element" do
       before do
-        expect(element).to receive(:ingredient_definition_for) do
+        expect(element).to receive(:ingredient_definition_for).at_least(:once) do
           {
             settings: {
               linkable: true,
@@ -63,7 +63,9 @@ RSpec.shared_examples_for "an alchemy ingredient" do
       end
 
       before do
-        expect(element).to receive(:ingredient_definition_for) { definition }
+        expect(element).to receive(:ingredient_definition_for).at_least(:once) do
+          definition
+        end
       end
 
       it "returns ingredient definition" do

data/lib/alchemy/upgrader/tasks/ingredients_migrator.rb

@@ -16,7 +16,7 @@ module Alchemy::Upgrader::Tasks
           # eager load all elements that have ingredients defined but no ingredient records yet.
           all_elements = Alchemy::Element
             .named(elements_with_ingredients.map { |d| d[:name] })
-            .includes(contents: { essence: :ingredient_association })
+            .includes(contents: :essence)
             .left_outer_joins(:ingredients).where(alchemy_ingredients: { id: nil })
             .to_a
           elements_with_ingredients.map do |element_definition|

data/lib/alchemy/version.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Alchemy
-  VERSION = "6.0.0-rc6"
+  VERSION = "6.0.1"
 
   def self.version
     VERSION

data/lib/alchemy.rb

@@ -3,7 +3,7 @@
 require "alchemy/admin/preview_url"
 
 module Alchemy
-  YAML_WHITELIST_CLASSES = %w(Symbol Date Regexp)
+  YAML_PERMITTED_CLASSES = %w[Symbol Date Regexp]
 
   # Define page preview sources
   #
@@ -35,9 +35,7 @@ module Alchemy
   #           acme/preview_source: Acme Vorschau
   #
   def self.preview_sources
-    @_preview_sources ||= begin
-      Set.new << Alchemy::Admin::PreviewUrl
-    end
+    @_preview_sources ||= Set.new << Alchemy::Admin::PreviewUrl
   end
 
   # Define page publish targets

data/lib/generators/alchemy/base.rb

@@ -17,8 +17,8 @@ module Alchemy
           # source and destination file names to use that engine.
           if ext != template_engine.to_s
             say_status :warning, "View uses unexpected template engine '#{ext}'.", :cyan
-            destination.gsub!(/#{template_engine}$/, ext)
-            source.gsub!(/#{template_engine}$/, ext)
+            destination = destination.gsub(/#{template_engine}$/, ext)
+            source = source.gsub(/#{template_engine}$/, ext)
           end
         end
 
@@ -33,7 +33,11 @@ module Alchemy
       end
 
       def load_alchemy_yaml(name)
-        YAML.safe_load(ERB.new(File.read("#{Rails.root}/config/alchemy/#{name}")).result, YAML_WHITELIST_CLASSES, [], true)
+        YAML.safe_load(
+          ERB.new(File.read(Rails.root.join("config", "alchemy", name))).result,
+          permitted_classes: YAML_PERMITTED_CLASSES,
+          aliases: true,
+        )
       rescue Errno::ENOENT
         puts "\nERROR: Could not read config/alchemy/#{name} file. Please run: `rails generate alchemy:install`"
       end

data/lib/generators/alchemy/install/install_generator.rb

@@ -23,6 +23,11 @@ module Alchemy
         default: false,
         desc: "Skip running the webpacker installer."
 
+      class_option :skip_db_create,
+        type: :boolean,
+        default: false,
+        desc: "Skip creting the database during install."
+
       source_root File.expand_path("files", __dir__)
 
       def setup
@@ -93,7 +98,10 @@ module Alchemy
       end
 
       def copy_alchemy_entry_point
-        webpack_config = YAML.load_file(app_root.join("config", "webpacker.yml"))[Rails.env]
+        webpack_config = YAML.safe_load(
+          File.read(app_root.join("config", "webpacker.yml")),
+          aliases: true
+        )[Rails.env]
         copy_file "alchemy_admin.js",
           app_root.join(webpack_config["source_path"], webpack_config["source_entry_path"], "alchemy/admin.js")
       end
@@ -104,7 +112,7 @@ module Alchemy
       end
 
       def setup_database
-        rake("db:create", abort_on_failure: true)
+        rake("db:create", abort_on_failure: true) unless options[:skip_db_create]
         # We can't invoke this rake task, because Rails will use wrong engine names otherwise
         rake("railties:install:migrations", abort_on_failure: true)
         rake("db:migrate", abort_on_failure: true)

data/package/src/image_loader.js

@@ -39,9 +39,11 @@ export default class ImageLoader {
     this.unbind()
   }
 
-  onError() {
+  onError(evt) {
+    const message = `Could not load "${this.image.src}"`
     this.removeSpinner()
-    this.parent.innerHtml = '<span class="icon warn"></span>'
+    this.parent.innerHTML = `<span class="icon error fas fa-exclamation-triangle" title="${message}" />`
+    console.error(message, evt)
     this.unbind()
   }
 

data/package/src/node_tree.js

@@ -1,12 +1,16 @@
 import Sortable from "sortablejs"
-import ajax from "./utils/ajax"
+import { patch } from "./utils/ajax"
 import { on } from "./utils/events"
 
 function displayNodeFolders() {
   document.querySelectorAll("li.menu-item").forEach((el) => {
     const leftIconArea = el.querySelector(".nodes_tree-left_images")
     const list = el.querySelector(".children")
-    const node = { folded: el.dataset.folded === "true", id: el.dataset.id, type: el.dataset.type }
+    const node = {
+      folded: el.dataset.folded === "true",
+      id: el.dataset.id,
+      type: el.dataset.type
+    }
 
     if (list.children.length > 0 || node.folded) {
       leftIconArea.innerHTML = HandlebarsTemplates.node_folder({ node: node })
@@ -17,13 +21,15 @@ function displayNodeFolders() {
 }
 
 function onFinishDragging(evt) {
-  const url = Alchemy.routes[evt.item.dataset.type].move_api_path(evt.item.dataset.id)
+  const url = Alchemy.routes[evt.item.dataset.type].move_api_path(
+    evt.item.dataset.id
+  )
   const data = {
     target_parent_id: evt.to.dataset.recordId,
     new_position: evt.newIndex
   }
 
-  ajax("PATCH", url, data)
+  patch(url, data)
     .then(() => {
       const message = Alchemy.t("Successfully moved menu item")
       Alchemy.growl(message)
@@ -38,10 +44,11 @@ function handleNodeFolders() {
   on("click", ".nodes_tree", ".node_folder", function () {
     const nodeId = this.dataset.recordId
     const menu_item = this.closest("li.menu-item")
-    const url = Alchemy.routes[this.dataset.recordType].toggle_folded_api_path(nodeId)
+    const url =
+      Alchemy.routes[this.dataset.recordType].toggle_folded_api_path(nodeId)
     const list = menu_item.querySelector(".children")
 
-    ajax("PATCH", url)
+    patch(url)
       .then(() => {
         list.classList.toggle("folded")
         menu_item.dataset.folded =

data/package/src/page_publication_fields.js

@@ -7,21 +7,22 @@ export default function () {
     const publication_date_fields = dialog.querySelector(
       ".page-publication-date-fields"
     )
+    const public_field = dialog.querySelector("#page_public")
 
-    dialog
-      .querySelector("#page_public")
-      .addEventListener("click", function (evt) {
-        const checkbox = evt.target
-        const now = new Date()
+    if(!public_field) return
 
-        if (checkbox.checked) {
-          publication_date_fields.classList.remove("hidden")
-          public_on_field._flatpickr.setDate(now)
-        } else {
-          publication_date_fields.classList.add("hidden")
-          public_on_field.value = ""
-        }
-        public_until_field.value = ""
-      })
+    public_field.addEventListener("click", function (evt) {
+      const checkbox = evt.target
+      const now = new Date()
+
+      if (checkbox.checked) {
+        publication_date_fields.classList.remove("hidden")
+        public_on_field._flatpickr.setDate(now)
+      } else {
+        publication_date_fields.classList.add("hidden")
+        public_on_field.value = ""
+      }
+      public_until_field.value = ""
+    })
   })
 }

data/package/src/page_sorter.js

@@ -0,0 +1,62 @@
+import Sortable from "sortablejs"
+import { patch } from "./utils/ajax"
+
+function onFinishDragging(evt) {
+  const pageId = evt.item.dataset.pageId
+  const url = Alchemy.routes.move_admin_page_path(pageId)
+  const data = {
+    target_parent_id: evt.to.dataset.parentId,
+    new_position: evt.newIndex
+  }
+
+  patch(url, data)
+    .then(async (response) => {
+      const pageData = await response.data
+      const pageEl = document.getElementById(`page_${pageId}`)
+      const urlPathEl = pageEl.querySelector(".sitemap_url")
+
+      Alchemy.growl(Alchemy.t("Successfully moved page"))
+      urlPathEl.textContent = pageData.url_path
+      displayPageFolders()
+    })
+    .catch((error) => {
+      Alchemy.growl(error.message || error, "error")
+    })
+}
+
+export function displayPageFolders() {
+  document.querySelectorAll("li.sitemap-item").forEach((el) => {
+    const pageFolderEl = el.querySelector(".page_folder")
+    const list = el.querySelector(".children")
+    const page = {
+      folded: el.dataset.folded === "true",
+      id: el.dataset.pageId,
+      type: el.dataset.type
+    }
+
+    if (list.children.length > 0 || page.folded) {
+      pageFolderEl.outerHTML = HandlebarsTemplates.page_folder({ page })
+    } else {
+      pageFolderEl.innerHTML = ""
+    }
+  })
+}
+
+export function createSortables(sortables) {
+  sortables.forEach((el) => {
+    new Sortable(el, {
+      group: "pages",
+      animation: 150,
+      fallbackOnBody: true,
+      swapThreshold: 0.65,
+      handle: ".handle",
+      onEnd: onFinishDragging
+    })
+  })
+}
+
+export default function () {
+  const sortables = document.querySelectorAll("ul.children")
+  displayPageFolders()
+  createSortables(sortables)
+}

data/package/src/picture_editors.js

@@ -1,11 +1,10 @@
-import debounce from "lodash/debounce"
-import max from "lodash/max"
-import ajax from "./utils/ajax"
+import debounce from "lodash-es/debounce"
+import max from "lodash-es/max"
+import { get } from "./utils/ajax"
 import ImageLoader from "./image_loader"
 
 const UPDATE_DELAY = 125
 const IMAGE_PLACEHOLDER = '<i class="icon far fa-image fa-fw"></i>'
-const EMPTY_IMAGE = '<img src="" class="img_paddingtop" />'
 const THUMBNAIL_SIZE = "160x120"
 
 class PictureEditor {
@@ -62,7 +61,7 @@ class PictureEditor {
     this.image.removeAttribute("alt")
     this.image.removeAttribute("src")
     this.imageLoader.load(true)
-    ajax("GET", `/admin/pictures/${this.pictureId}/url`, {
+    get(Alchemy.routes.url_admin_picture_path(this.pictureId), {
       crop: this.imageCropperEnabled,
       crop_from: this.cropFrom,
       crop_size: this.cropSize,
@@ -83,9 +82,10 @@ class PictureEditor {
   ensureImage() {
     if (this.image) return
 
-    this.thumbnailBackground.innerHTML = EMPTY_IMAGE
-    this.image = this.container.querySelector("img")
-    this.imageLoader = new ImageLoader(this.image)
+    const img = new Image()
+    this.thumbnailBackground.replaceChildren(img)
+    this.image = img
+    this.imageLoader = new ImageLoader(img)
   }
 
   removeImage() {

data/package/src/sitemap.js

@@ -1,12 +1,15 @@
 // The admin sitemap Alchemy class
+import PageSorter from "./page_sorter"
+import { on } from "./utils/events"
+import { get, patch } from "./utils/ajax"
+import { createSortables, displayPageFolders } from "./page_sorter"
 
 export default class Sitemap {
   // Storing some objects.
   constructor(options) {
-    const list_template_regexp = new RegExp("/" + options.page_root_id, "g")
     const list_template_html = document
       .getElementById("sitemap-list")
-      .innerHTML.replace(list_template_regexp, "/{{id}}")
+      .innerHTML.replace(/__ID__/g, "{{id}}")
     this.search_field = document.querySelector(".search_input_field")
     this.filter_field_clear = document.querySelector(".search_field_clear")
     this.filter_field_clear.removeAttribute("href")
@@ -24,56 +27,63 @@ export default class Sitemap {
 
   // Loads the sitemap
   load(pageId) {
-    const spinner = this.options.spinner || new Alchemy.Spinner("medium")
+    const spinner = new Alchemy.Spinner("medium")
     const spinTarget = this.sitemap_wrapper
     spinTarget.innerHTML = ""
     spinner.spin(spinTarget)
-    this.fetch(
-      `${this.options.url}?id=${pageId}&full=${this.options.full}`
-    ).then(async (response) => {
-      this.render(await response.json())
-      spinner.stop()
-    })
+    get(this.options.url, { id: pageId })
+      .then(async (response) => {
+        this.render(await response.data)
+        this.handlePageFolders()
+        spinner.stop()
+      })
+      .catch(this.errorHandler)
   }
 
-  // Reload the sitemap for a specific branch
-  reload(pageId) {
-    const spinner = new Alchemy.Spinner("small")
-    const spinTarget = document.getElementById(`fold_button_${pageId}`)
-    spinTarget.querySelector(".far").remove()
-    spinner.spin(spinTarget)
-    this.fetch(`${this.options.url}?id=${pageId}`).then(async (response) => {
-      this.render(await response.json(), pageId)
-      spinner.stop()
-    })
-  }
+  // Watch page folder clicks and re-render the page branch
+  handlePageFolders() {
+    on(
+      "click",
+      "#sitemap",
+      ".page_folder",
+      function (evt) {
+        const spinner = new Alchemy.Spinner("small")
+        const pageFolder = evt.target.closest(".page_folder")
+        const pageId = pageFolder.dataset.pageId
+        pageFolder.innerHTML = ""
+        spinner.spin(pageFolder)
 
-  fetch(url) {
-    return fetch(url).catch((error) => console.warn(`Request failed: ${error}`))
+        patch(Alchemy.routes.fold_admin_page_path(pageId))
+          .then(async (response) => {
+            this.reRender(pageId, await response.data)
+            spinner.stop()
+          })
+          .catch(this.errorHandler)
+      }.bind(this)
+    )
   }
 
   // Renders the sitemap
-  render(data, foldingId) {
-    let renderTarget, renderTemplate
+  render(data) {
+    const renderTarget = this.sitemap_wrapper
+    const renderTemplate = this.template
 
-    if (foldingId) {
-      renderTarget = document.getElementById(`page_${foldingId}`)
-      renderTemplate = this.list_template
-      renderTarget.outerHTML = renderTemplate({ children: data.pages })
-    } else {
-      renderTarget = this.sitemap_wrapper
-      renderTemplate = this.template
-      renderTarget.innerHTML = renderTemplate({ children: data.pages })
-    }
+    renderTarget.innerHTML = renderTemplate({ children: data.pages })
     this.items = document
       .getElementById("sitemap")
       .querySelectorAll(".sitemap_page")
     this.sitemap_wrapper = document.getElementById("sitemap-wrapper")
     this._observe()
+    PageSorter()
+  }
 
-    if (this.options.ready) {
-      this.options.ready()
-    }
+  reRender(pageId, data) {
+    let pageEl = document.getElementById(`page_${pageId}`)
+    pageEl.outerHTML = this.list_template({ children: data.pages })
+    pageEl = document.getElementById(`page_${pageId}`)
+    const sortables = pageEl.querySelectorAll("ul.children")
+    createSortables(sortables)
+    displayPageFolders()
   }
 
   // Filters the sitemap
@@ -130,4 +140,9 @@ export default class Sitemap {
       return false
     })
   }
+
+  errorHandler(error) {
+    Alchemy.growl(error.message || error, "error")
+    console.error(error)
+  }
 }