alchemy_cms 5.2.5 → 6.0.0.b1

data/lib/alchemy/test_support.rb

@@ -2,17 +2,8 @@
 
 module Alchemy
   module TestSupport
-    class << self
-      def factory_paths
-        Dir[
-          ::Alchemy::Engine.root.join("lib", "alchemy", "test_support", "factories", "*_factory.rb")
-        ].map { |path| path.sub(/.rb\z/, "") }
-      end
-      deprecate factory_paths: :factories_path, deprecator: Alchemy::Deprecation
-
-      def factories_path
-        ::Alchemy::Engine.root.join("lib", "alchemy", "test_support", "factories")
-      end
+    def self.factories_path
+      ::Alchemy::Engine.root.join("lib", "alchemy", "test_support", "factories")
     end
   end
 end

data/lib/alchemy/tinymce.rb

@@ -38,6 +38,10 @@ module Alchemy
         content_definitions_from_elements(page.descendent_element_definitions)
       end
 
+      def custom_config_ingredients(page)
+        ingredient_definitions_from_elements(page.descendent_element_definitions)
+      end
+
       private
 
       def content_definitions_from_elements(definitions)
@@ -52,6 +56,19 @@ module Alchemy
           contents.map { |c| c.merge("element" => el["name"]) }
         end.flatten.compact
       end
+
+      def ingredient_definitions_from_elements(definitions)
+        definitions.collect do |el|
+          next if el["ingredients"].blank?
+
+          ingredients = el["ingredients"].select do |c|
+            c["settings"] && c["settings"]["tinymce"].is_a?(Hash)
+          end
+          next if ingredients.blank?
+
+          ingredients.map { |c| c.merge("element" => el["name"]) }
+        end.flatten.compact
+      end
     end
   end
 end

data/lib/alchemy/upgrader/five_point_zero.rb

@@ -1,19 +1,9 @@
 # frozen_string_literal: true
 
 require_relative "tasks/harden_gutentag_migrations"
-require "rails/generators"
-require "thor"
-require "alchemy/install/tasks"
-require "alchemy/version"
 
 module Alchemy
   class Upgrader::FivePointZero < Upgrader
-  	include Rails::Generators::Actions
-  	include Thor::Base
-  	include Thor::Actions
-
-  	source_root File.expand_path("../../generators/alchemy/install/files", __dir__)
-
     class << self
       def install_gutentag_migrations
         desc "Install Gutentag migrations"
@@ -46,28 +36,6 @@ module Alchemy
           log "Root page not found.", :skip
         end
       end
-
-      def run_webpacker_installer
-        # Webpacker does not create a package.json, but we need one
-        unless File.exist? app_root.join("package.json")
-          in_root { run "echo '{}' > package.json" }
-        end
-        new.rake("webpacker:install", abort_on_failure: true)
-      end
-
-      def add_npm_package
-        new.run "yarn add @alchemy_cms/admin@~#{Alchemy.version}"
-      end
-
-      def copy_alchemy_entry_point
-        webpack_config = YAML.load_file(app_root.join("config", "webpacker.yml"))[Rails.env]
-        new.copy_file "alchemy_admin.js",
-          app_root.join(webpack_config["source_path"], webpack_config["source_entry_path"], "alchemy/admin.js")
-      end
-
-      def app_root
-        @_app_root ||= Rails.root
-      end
     end
   end
 end

data/lib/alchemy/upgrader/six_point_zero.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require_relative "tasks/add_page_versions"
+require_relative "tasks/ingredients_migrator"
+
+module Alchemy
+  class Upgrader::SixPointZero < Upgrader
+    class << self
+      def create_public_page_versions
+        desc "Create public page versions for pages"
+        Alchemy::Upgrader::Tasks::AddPageVersions.new.create_public_page_versions
+      end
+
+      def create_ingredients
+        desc "Create ingredients for elements with ingredients defined"
+        Alchemy::Upgrader::Tasks::IngredientsMigrator.new.create_ingredients
+        log "Done.", :success
+      end
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require "alchemy/upgrader"
+
+module Alchemy::Upgrader::Tasks
+  class AddPageVersions < Thor
+    include Thor::Actions
+
+    no_tasks do
+      def create_public_page_versions
+        Alchemy::Deprecation.silence do
+          Alchemy::Page.where.not(legacy_public_on: nil).find_each do |page|
+            next if page.versions.published.any?
+
+            Alchemy::Page.transaction do
+              page.versions.create!(
+                public_on: page.legacy_public_on,
+                public_until: page.legacy_public_until
+              ).tap do |version|
+                # We must not use .find_each here to not mess up the order of elements
+                page.draft_version.elements.not_nested.available.each do |element|
+                  Alchemy::Element.copy(element, page_version_id: version.id)
+                end
+              end
+            end
+
+            print "."
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require "alchemy/upgrader"
+
+module Alchemy::Upgrader::Tasks
+  class IngredientsMigrator < Thor
+    include Thor::Actions
+
+    no_tasks do
+      def create_ingredients
+        Alchemy::Deprecation.silence do
+          elements_with_ingredients = Alchemy::ElementDefinition.all.select { |d| d.key?(:ingredients) }
+          # 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 })
+            .left_outer_joins(:ingredients).where(alchemy_ingredients: { id: nil })
+            .to_a
+          elements_with_ingredients.map do |element_definition|
+            elements = all_elements.select { |e| e.name == element_definition[:name] }
+            if elements.any?
+              puts "-- Creating ingredients for #{elements.count} #{element_definition[:name]}(s)"
+              elements.each do |element|
+                Alchemy::Element.transaction do
+                  element.ingredients = element_definition[:ingredients].map do |ingredient_definition|
+                    content = element.content_by_name(ingredient_definition[:role])
+                    next unless content
+
+                    ingredient = Alchemy::Ingredient.build(role: ingredient_definition[:role], element: element)
+                    belongs_to_associations = content.essence.class.reflect_on_all_associations(:belongs_to)
+                    if belongs_to_associations.any?
+                      ingredient.related_object = content.essence.public_send(belongs_to_associations.first.name)
+                    else
+                      ingredient.value = content.ingredient
+                    end
+                    content.destroy!
+                    print "."
+                    ingredient
+                  end.compact
+                end
+              end
+              puts "\n"
+            else
+              puts "-- No #{element_definition[:name]} elements found for migration."
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/alchemy/version.rb

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

data/lib/generators/alchemy/elements/elements_generator.rb

@@ -14,6 +14,7 @@ module Alchemy
         @elements.each do |element|
           @element = element
           @contents = element["contents"] || []
+          @ingredients = element["ingredients"] || []
           @element_name = element_name(element)
           conditional_template "view.html.#{template_engine}", "#{elements_dir}/_#{@element_name}.html.#{template_engine}"
         end

data/lib/generators/alchemy/elements/templates/view.html.erb

@@ -9,6 +9,15 @@
     <%%= el.render :<%= content["name"] %> %>
     <%- end -%>
   <%- end -%>
+  <%- @ingredients.each do |ingredient| -%>
+    <%- if @ingredients.length > 1 -%>
+    <div class="<%= ingredient["role"] %>">
+      <%%= el.render(:<%= ingredient["role"] %>) %>
+    </div>
+    <%- else -%>
+    <%%= el.render(:<%= ingredient["role"] %>) %>
+    <%- end -%>
+  <%- end -%>
   <%- if @element['nestable_elements'].present? -%>
     <%%= render <%= @element_name %>.nested_elements.available %>
   <%- end -%>

data/lib/generators/alchemy/elements/templates/view.html.haml

@@ -8,6 +8,15 @@
     = el.render :<%= content["name"] %>
     <%- end -%>
   <%- end -%>
+  <%- @ingredients.each do |ingredient| -%>
+    <%- if @ingredients.length > 1 -%>
+    .<%= ingredient["role"] %>
+      = el.render(:<%= ingredient["role"] %>)
+    </div>
+    <%- else -%>
+    = el.render(:<%= ingredient["role"] %>)
+    <%- end -%>
+  <%- end -%>
   <%- if @element['nestable_elements'].present? -%>
     = render <%= @element_name -%>.nested_elements.available
   <%- end -%>

data/lib/generators/alchemy/elements/templates/view.html.slim

@@ -8,6 +8,15 @@
     = el.render :<%= content["name"] %>
     <%- end -%>
   <%- end -%>
+  <%- @ingredients.each do |ingredient| -%>
+    <%- if @ingredients.length > 1 -%>
+    .<%= ingredient["role"] %>
+      = el.render(:<%= ingredient["role"] %>)
+    </div>
+    <%- else -%>
+    = el.render(:<%= ingredient["role"] %>)
+    <%- end -%>
+  <%- end -%>
   <%- if @element['nestable_elements'].present? -%>
     = render <%= @element_name -%>.nested_elements.available
   <%- end -%>

data/lib/generators/alchemy/ingredient/ingredient_generator.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+require "rails"
+
+module Alchemy
+  module Generators
+    class IngredientGenerator < ::Rails::Generators::Base
+      desc "This generator generates an Alchemy ingredient class for you."
+      argument :class_name, banner: "ingredient_class_name"
+      source_root File.expand_path("templates", __dir__)
+
+      def init
+        @class_name = class_name.classify
+        @ingredients_view_path = "app/views/alchemy/ingredients"
+      end
+
+      def create_model
+        template "model.rb.tt", "app/models/alchemy/ingredients/#{file_name}.rb"
+      end
+
+      def copy_templates
+        @ingredient_editor_local = "#{file_name}_editor"
+        @ingredient_view_local = "#{file_name}_view"
+        template "view.html.erb", "#{@ingredients_view_path}/_#{file_name}_view.html.erb"
+        template "editor.html.erb", "#{@ingredients_view_path}/_#{file_name}_editor.html.erb"
+      end
+
+      def show_todo
+        say "\nPlease check the generated files and alter them to fit your needs."
+      end
+
+      private
+
+      def file_name
+        @_file_name ||= @class_name.classify.demodulize.underscore
+      end
+    end
+  end
+end

data/lib/generators/alchemy/ingredient/templates/editor.html.erb

@@ -0,0 +1,14 @@
+<%%#
+  Available locals:
+  * <%= @ingredient_editor_local %> - An Alchemy::IngredientEditor instance
+
+  Please consult Alchemy::IngredientEditor.rb docs for further methods on the ingredient object
+%>
+<%%= content_tag :div,
+  class: <%= @ingredient_editor_local %>.css_classes,
+  data: <%= @ingredient_editor_local %>.data_attributes do %>
+  <%%= element_form.fields_for(:ingredients, <%= @ingredient_editor_local %>.ingredient) do |f| %>
+    <%%= ingredient_label(<%= @ingredient_editor_local %>) %>
+    <%%= f.text_field :value %>
+  <%% end %>
+<%% end %>

data/lib/generators/alchemy/ingredient/templates/model.rb.tt

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Alchemy
+  module Ingredients
+    class <%= @class_name %> < Alchemy::Ingredient
+      # Set additional attributes that get stored in the `data` JSON column
+      # store_accessor :data, :some, :attribute
+
+      # Set a related_object alias for convenience
+      # related_object_alias :some_association_name, class_name: "Some::Klass"
+    end
+  end
+end

data/lib/generators/alchemy/ingredient/templates/view.html.erb

@@ -0,0 +1 @@
+<%%= <%= @ingredient_view_local %>.value %>

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

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 require "rails/generators"
 require "alchemy/install/tasks"
-require "alchemy/version"
 
 module Alchemy
   module Generators
@@ -89,7 +88,7 @@ module Alchemy
       end
 
       def add_npm_package
-        run "yarn add @alchemy_cms/admin@~#{Alchemy.version}"
+        run "yarn add @alchemy_cms/admin"
       end
 
       def copy_alchemy_entry_point

data/lib/generators/alchemy/install/templates/dragonfly.rb.tt

@@ -7,7 +7,7 @@
 # http://markevans.github.io/dragonfly/cache/
 #
 # A complete reference can be found at
-# http://markevans.github.io/dragonfly/configuration/
+# http://markevans.github.io/dragonfly/configuration
 #
 # Pictures
 #

data/lib/generators/alchemy/menus/templates/node.html.erb

@@ -1,4 +1,4 @@
-<%% cache [node, @page, @preview_mode] do %>
+<%% cache node do %>
   <%%= content_tag :li, class: ['nav-item', node.children.any? ? 'dropdown' : nil].compact do %>
     <%%= link_to_if node.url,
       node.name,

data/lib/generators/alchemy/menus/templates/node.html.haml

@@ -1,4 +1,4 @@
-- cache [node, @page, @preview_mode] do
+- cache node do
   = content_tag :li,
     class: ['nav-item', node.children.any? ? 'dropdown' : nil].compact do
     = link_to_if node.url,

data/lib/generators/alchemy/menus/templates/node.html.slim

@@ -1,4 +1,4 @@
-- cache [node, @page, @preview_mode] do
+- cache node do
   = content_tag :li,
     class: ['nav-item', node.children.any? ? 'dropdown' : nil].compact do
     = link_to_if node.url,

data/lib/generators/alchemy/menus/templates/wrapper.html.erb

@@ -1,4 +1,4 @@
-<%% cache [menu, @page, @preview_mode] do %>
+<%% cache menu do %>
   <ul class="nav">
     <%%= render partial: menu.to_partial_path,
       collection: menu.children.includes(:page, :children),

data/lib/generators/alchemy/menus/templates/wrapper.html.haml

@@ -1,4 +1,4 @@
-- cache [menu, @page, @preview_mode] do
+- cache menu do
   %ul.nav
     = render partial: menu.to_partial_path,
       collection: menu.children.includes(:page, :children),

data/lib/generators/alchemy/menus/templates/wrapper.html.slim

@@ -1,4 +1,4 @@
-- cache [menu, @page, @preview_mode] do
+- cache menu do
   ul.nav
     = render partial: menu.to_partial_path,
       collection: menu.children.includes(:page, :children),

data/lib/tasks/alchemy/tidy.rake

@@ -8,6 +8,8 @@ namespace :alchemy do
       Rake::Task["alchemy:tidy:element_positions"].invoke
       Rake::Task["alchemy:tidy:content_positions"].invoke
       Rake::Task["alchemy:tidy:remove_orphaned_records"].invoke
+      Rake::Task["alchemy:tidy:remove_trashed_elements"].invoke
+      Rake::Task["alchemy:tidy:remove_duplicate_legacy_urls"].invoke
     end
 
     desc "Fixes element positions."
@@ -36,6 +38,16 @@ namespace :alchemy do
       Alchemy::Tidy.remove_orphaned_contents
     end
 
+    desc "Remove trashed elements."
+    task remove_trashed_elements: [:environment] do
+      Alchemy::Tidy.remove_trashed_elements
+    end
+
+    desc "Remove duplicate legacy URLs"
+    task remove_duplicate_legacy_urls: [:environment] do
+      Alchemy::Tidy.remove_duplicate_legacy_urls
+    end
+
     desc "List Alchemy elements usage"
     task elements_usage: :environment do
       puts "\n"

data/lib/tasks/alchemy/upgrade.rake

@@ -7,6 +7,7 @@ namespace :alchemy do
   task upgrade: [
     "alchemy:upgrade:prepare",
     "alchemy:upgrade:5.0:run",
+    "alchemy:upgrade:6.0:run",
   ] do
     Alchemy::Upgrader.display_todos
   end
@@ -42,9 +43,6 @@ namespace :alchemy do
         "alchemy:upgrade:5.0:install_gutentag_migrations",
         "alchemy:upgrade:5.0:remove_layout_roots",
         "alchemy:upgrade:5.0:remove_root_page",
-        "alchemy:upgrade:5.0:run_webpacker_installer",
-        "alchemy:upgrade:5.0:add_npm_package",
-        "alchemy:upgrade:5.0:copy_alchemy_entry_point",
       ]
 
       desc "Install Gutentag migrations"
@@ -61,22 +59,30 @@ namespace :alchemy do
       task remove_root_page: [:environment] do
         Alchemy::Upgrader::FivePointZero.remove_root_page
       end
+    end
 
-      desc "Run webpacker installer"
-      task run_webpacker_installer: [:environment] do
-        Alchemy::Upgrader::FivePointZero.run_webpacker_installer
-      end
+    desc "Upgrade Alchemy to v6.0"
+    task "6.0" => [
+      "alchemy:upgrade:prepare",
+      "alchemy:upgrade:6.0:run",
+    ] do
+      Alchemy::Upgrader.display_todos
+    end
+
+    namespace "6.0" do
+      task "run" => [
+        "alchemy:upgrade:6.0:create_public_page_versions",
+        "alchemy:upgrade:6.0:create_ingredients",
+      ]
 
-      desc "Add NPM package"
-      task add_npm_package: [:environment] do
-        puts "adding npm_package..."
-        Alchemy::Upgrader::FivePointZero.add_npm_package
+      desc "Create public page versions"
+      task create_public_page_versions: [:environment] do
+        Alchemy::Upgrader::SixPointZero.create_public_page_versions
       end
 
-      desc "Copy alchemy entry point"
-      task copy_alchemy_entry_point: [:environment] do
-        puts "copying alchemy entry point"
-        Alchemy::Upgrader::FivePointZero.copy_alchemy_entry_point
+      desc "Create ingredients for elements with ingredients defined"
+      task create_ingredients: [:environment] do
+        Alchemy::Upgrader::SixPointZero.create_ingredients
       end
     end
   end

data/package/admin.js

@@ -1,6 +1,10 @@
 import translate from "./src/i18n"
 import translationData from "./src/translations"
 import NodeTree from "./src/node_tree"
+import fileEditors from "./src/file_editors"
+import pictureEditors from "./src/picture_editors"
+import ImageLoader from "./src/image_loader"
+import ImageCropper from "./src/image_cropper"
 
 // Global Alchemy object
 if (typeof window.Alchemy === "undefined") {
@@ -12,5 +16,9 @@ Object.assign(Alchemy, {
   // Global utility method for translating a given string
   t: translate,
   translations: Object.assign(Alchemy.translations || {}, translationData),
-  NodeTree
+  NodeTree,
+  fileEditors,
+  pictureEditors,
+  ImageLoader: ImageLoader.init,
+  ImageCropper
 })

data/package/src/file_editors.js

@@ -0,0 +1,28 @@
+class FileEditor {
+  constructor(container) {
+    this.container = container
+    this.deleteLink = container.querySelector(".remove_file_link")
+    this.fileIcon = container.querySelector(".file_icon")
+    this.fileName = container.querySelector(".file_name")
+    this.deleteLink.addEventListener("click", this.removeFile.bind(this))
+    this.formFieldId = this.deleteLink.dataset.formFieldId
+    this.formField = container.querySelector(`#${this.formFieldId}`)
+    this.assignFileText = this.deleteLink.dataset.assignFileText
+  }
+
+  removeFile(event) {
+    event.stopPropagation()
+    this.formField.value = ""
+    this.fileIcon.innerHTML = ""
+    this.fileName.innerHTML = ""
+    this.deleteLink.classList.add("hidden")
+    Alchemy.setElementDirty(this.container.closest(".element-editor"))
+    return false
+  }
+}
+
+export default function init(selector) {
+  document.querySelectorAll(selector).forEach((node) => {
+    new FileEditor(node)
+  })
+}

data/package/src/image_cropper.js

@@ -0,0 +1,103 @@
+export default class ImageCropper {
+  constructor(
+    minSize,
+    defaultBox,
+    aspectRatio,
+    trueSize,
+    formFieldIds,
+    elementId
+  ) {
+    this.initialized = false
+
+    this.minSize = minSize
+    this.defaultBox = defaultBox
+    this.aspectRatio = aspectRatio
+    this.trueSize = trueSize
+    this.cropFromField = document.getElementById(formFieldIds[0])
+    this.cropSizeField = document.getElementById(formFieldIds[1])
+    this.elementId = elementId
+    this.dialog = Alchemy.currentDialog()
+    this.dialog.options.closed = this.destroy
+
+    this.init()
+    this.bind()
+  }
+
+  get jcropOptions() {
+    return {
+      onSelect: this.update.bind(this),
+      setSelect: this.box,
+      aspectRatio: this.aspectRatio,
+      minSize: this.minSize,
+      boxWidth: 800,
+      boxHeight: 600,
+      trueSize: this.trueSize,
+      closed: this.destroy.bind(this)
+    }
+  }
+
+  get cropFrom() {
+    if (this.cropFromField.value) {
+      return this.cropFromField.value.split("x").map((v) => parseInt(v))
+    }
+  }
+
+  get cropSize() {
+    if (this.cropSizeField.value) {
+      return this.cropSizeField.value.split("x").map((v) => parseInt(v))
+    }
+  }
+
+  get box() {
+    if (this.cropFrom && this.cropSize) {
+      return [
+        this.cropFrom[0],
+        this.cropFrom[1],
+        this.cropFrom[0] + this.cropSize[0],
+        this.cropFrom[1] + this.cropSize[1]
+      ]
+    } else {
+      return this.defaultBox
+    }
+  }
+
+  init() {
+    if (!this.initialized) {
+      this.api = $.Jcrop("#imageToCrop", this.jcropOptions)
+      this.initialized = true
+    }
+  }
+
+  update(coords) {
+    this.cropFromField.value = Math.round(coords.x) + "x" + Math.round(coords.y)
+    this.cropFromField.dispatchEvent(new Event("change"))
+    this.cropSizeField.value = Math.round(coords.w) + "x" + Math.round(coords.h)
+    this.cropFromField.dispatchEvent(new Event("change"))
+  }
+
+  reset() {
+    this.api.setSelect(this.defaultBox)
+    this.cropFromField.value = `${this.box[0]}x${this.box[1]}`
+    this.cropSizeField.value = `${this.box[2]}x${this.box[3] - this.box[1]}`
+  }
+
+  destroy() {
+    if (this.api) {
+      this.api.destroy()
+    }
+    this.initialized = false
+    return true
+  }
+
+  bind() {
+    this.dialog.dialog_body.find('button[type="submit"]').click(() => {
+      Alchemy.setElementDirty(`[data-element-id='${this.elementId}']`)
+      this.dialog.close()
+      return false
+    })
+    this.dialog.dialog_body.find('button[type="reset"]').click(() => {
+      this.reset()
+      return false
+    })
+  }
+}