alchemy_cms 4.6.6 → 5.0.0.beta1

data/lib/generators/alchemy/install/files/alchemy_admin.js

@@ -0,0 +1 @@
+import "@alchemy_cms/admin"

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

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+require "rails/generators"
+
+module Alchemy
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      desc "Installs Alchemy into your App."
+
+      class_option :skip_demo_files,
+        type: :boolean,
+        default: false,
+        desc: "Skip creation of demo element, page and application layout."
+
+      class_option :skip_webpacker_installer,
+        type: :boolean,
+        default: false,
+        desc: "Skip running the webpacker installer."
+
+      source_root File.expand_path("files", __dir__)
+
+      def copy_config
+        copy_file "#{gem_config_path}/config.yml", app_config_path.join("alchemy", "config.yml")
+      end
+
+      def copy_yml_files
+        %w(elements page_layouts menus).each do |file|
+          template "#{__dir__}/templates/#{file}.yml.tt", app_config_path.join("alchemy", "#{file}.yml")
+        end
+      end
+
+      def install_assets
+        copy_file "all.js", app_vendor_assets_path.join("javascripts", "alchemy", "admin", "all.js")
+        copy_file "all.css", app_vendor_assets_path.join("stylesheets", "alchemy", "admin", "all.css")
+      end
+
+      def copy_demo_views
+        return if options[:skip_demo_files]
+
+        copy_file "application.html.erb", app_views_path.join("layouts", "application.html.erb")
+        copy_file "article.scss", app_assets_path.join("stylesheets", "alchemy", "elements", "article.scss")
+
+        stylesheet_require = " *= require_tree ./alchemy/elements\n"
+        if File.exist?(app_assets_path.join("stylesheets", "application.css"))
+          insert_into_file app_assets_path.join("stylesheets", "application.css"), stylesheet_require,
+            before: " */"
+        else
+          create_file app_assets_path.join("stylesheets", "application.css"), "/*\n#{stylesheet_require} */\n"
+        end
+
+        copy_file "_article.html.erb", app_views_path.join("alchemy", "elements", "_article.html.erb")
+        copy_file "_standard.html.erb", app_views_path.join("alchemy", "page_layouts", "_standard.html.erb")
+        copy_file "alchemy.en.yml", app_config_path.join("locales", "alchemy.en.yml")
+      end
+
+      def copy_dragonfly_config
+        template "#{__dir__}/templates/dragonfly.rb.tt", app_config_path.join("initializers", "dragonfly.rb")
+      end
+
+      def install_gutentag_migrations
+        rake "gutentag:install:migrations"
+      end
+
+      def run_webpacker_installer
+        unless options[:skip_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
+          rake("webpacker:install", abort_on_failure: true)
+        end
+      end
+
+      def add_npm_package
+        run "yarn add @alchemy_cms/admin"
+      end
+
+      def copy_alchemy_entry_point
+        webpack_config = YAML.load_file(app_root.join("config", "webpacker.yml"))[Rails.env]
+        copy_file "alchemy_admin.js",
+          app_root.join(webpack_config["source_path"], webpack_config["source_entry_path"], "alchemy/admin.js")
+      end
+
+      private
+
+      def gem_config_path
+        @_config_path ||= File.expand_path("../../../../config/alchemy", __dir__)
+      end
+
+      def app_config_path
+        @_app_config_path ||= app_root.join("config")
+      end
+
+      def app_views_path
+        @_app_views_path ||= app_root.join("app", "views")
+      end
+
+      def app_assets_path
+        @_app_assets_path ||= app_root.join("app", "assets")
+      end
+
+      def app_vendor_assets_path
+        @_app_vendor_assets_path ||= app_root.join("vendor", "assets")
+      end
+
+      def app_root
+        @_app_root ||= Rails.root
+      end
+    end
+  end
+end

data/lib/{rails/generators → generators}/alchemy/menus/menus_generator.rb

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
-require_relative '../base'
+require_relative "../base"
 
 module Alchemy
   module Generators
     class MenusGenerator < Base
       desc "This generator generates Alchemy menu partials."
-      source_root File.expand_path('templates', __dir__)
+      source_root File.expand_path("templates", __dir__)
 
       def create_partials
         menus = Alchemy::Node.available_menu_names

data/lib/{rails/generators → generators}/alchemy/menus/templates/node.html.erb

@@ -9,10 +9,7 @@
       rel: node.nofollow? ? 'nofollow' : nil %>
     <%% if node.children.any? %>
       <ul class="dropdown-menu">
-        <%%= render partial: options[:node_partial_name],
-          collection: node.children.includes(:page, :children),
-          locals: { options: options },
-          as: 'node' %>
+        <%%= render node.children.includes(:page, :children), as: 'node' %>
       </ul>
     <%% end %>
   <%% end %>

data/lib/{rails/generators → generators}/alchemy/menus/templates/node.html.haml

@@ -10,7 +10,4 @@
       rel: node.nofollow? ? 'nofollow' : nil
       - if node.children.any?
         %ul.dropdown-menu
-          = render partial: options[:node_partial_name],
-            collection: node.children.includes(:page, :children),
-            locals: { options: options },
-            as: 'node'
+          = render node.children.includes(:page, :children), as: 'node'

data/lib/{rails/generators → generators}/alchemy/menus/templates/node.html.slim

@@ -10,7 +10,4 @@
       rel: node.nofollow? ? 'nofollow' : nil
       - if node.children.any?
         ul.dropdown-menu
-          = render partial: options[:node_partial_name],
-            collection: node.children.includes(:page, :children),
-            locals: { options: options },
-            as: 'node'
+          = render node.children.includes(:page, :children), as: 'node'

data/lib/{rails/generators → generators}/alchemy/menus/templates/wrapper.html.erb

@@ -1,6 +1,6 @@
 <%% cache menu do %>
   <ul class="nav">
-    <%%= render partial: options[:node_partial_name],
+    <%%= render partial: menu.to_partial_path,
       collection: menu.children.includes(:page, :children),
       locals: { options: options },
       as: 'node' %>

data/lib/{rails/generators → generators}/alchemy/menus/templates/wrapper.html.haml

@@ -1,6 +1,6 @@
 - cache menu do
   %ul.nav
-    = render partial: options[:node_partial_name],
+    = render partial: menu.to_partial_path,
       collection: menu.children.includes(:page, :children),
       locals: { options: options },
       as: 'node'

data/lib/{rails/generators → generators}/alchemy/menus/templates/wrapper.html.slim

@@ -1,6 +1,6 @@
 - cache menu do
   ul.nav
-    = render partial: options[:node_partial_name],
+    = render partial: menu.to_partial_path,
       collection: menu.children.includes(:page, :children),
       locals: { options: options },
       as: 'node'

data/lib/{rails/generators → generators}/alchemy/module/module_generator.rb

@@ -1,11 +1,12 @@
-require 'rails'
+# frozen_string_literal: true
+require "rails"
 
 module Alchemy
   module Generators
     class ModuleGenerator < ::Rails::Generators::Base
       desc "This generator generates an Alchemy module for you."
       argument :module_name, banner: "your_module_name"
-      source_root File.expand_path('templates', __dir__)
+      source_root File.expand_path("templates", __dir__)
 
       def init
         @module_name = module_name.downcase

data/lib/{rails/generators → generators}/alchemy/page_layouts/page_layouts_generator.rb

@@ -1,16 +1,17 @@
-require_relative '../base'
+# frozen_string_literal: true
+require_relative "../base"
 
 module Alchemy
   module Generators
     class PageLayoutsGenerator < Base
       desc "This generator generates your page_layouts view partials."
-      source_root File.expand_path('templates', __dir__)
+      source_root File.expand_path("templates", __dir__)
 
       def create_partials
-        @page_layouts = load_alchemy_yaml('page_layouts.yml')
+        @page_layouts = load_alchemy_yaml("page_layouts.yml")
         return unless @page_layouts
+
         @page_layouts.each do |page_layout|
-          next if page_layout['redirects_to_external']
           @page_layout_name = page_layout["name"].underscore
           conditional_template "layout.html.#{template_engine}", "#{page_layouts_dir}/_#{@page_layout_name}.html.#{template_engine}"
         end

data/lib/{rails/generators → generators}/alchemy/site_layouts/site_layouts_generator.rb

@@ -1,14 +1,16 @@
-require_relative '../base'
+# frozen_string_literal: true
+require_relative "../base"
 
 module Alchemy
   module Generators
     class SiteLayoutsGenerator < Base
       desc "This generator generates your site layouts view partials."
-      source_root File.expand_path('templates', __dir__)
+      source_root File.expand_path("templates", __dir__)
 
       def create_partials
         @sites = Alchemy::Site.all
         return unless @sites
+
         @sites.each do |site|
           @site_name = site.name.parameterize.underscore
           conditional_template "layout.html.#{template_engine}", "#{site_layouts_dir}/_#{@site_name}.html.#{template_engine}"

data/lib/{rails/generators → generators}/alchemy/views/views_generator.rb

@@ -1,4 +1,5 @@
-require 'rails'
+# frozen_string_literal: true
+require "rails"
 
 module Alchemy
   module Generators
@@ -21,17 +22,17 @@ module Alchemy
 
       def copy_alchemy_views
         views_to_copy.each do |dir|
-          directory dir, Rails.root.join('app/views/alchemy', dir)
+          directory dir, Rails.root.join("app/views/alchemy", dir)
         end
       end
 
       private
 
       def views_to_copy
-        if @options['except']
-          ALCHEMY_VIEWS - @options['except']
-        elsif @options['only']
-          ALCHEMY_VIEWS.select { |v| @options['only'].include?(v) }
+        if @options["except"]
+          ALCHEMY_VIEWS - @options["except"]
+        elsif @options["only"]
+          ALCHEMY_VIEWS.select { |v| @options["only"].include?(v) }
         else
           ALCHEMY_VIEWS
         end

data/lib/kaminari/scoped_pagination_url_helper.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # A Kaminari patch for scoping the urls.
 Kaminari::Helpers::Tag.class_eval do
   def page_url_for(page)

data/lib/tasks/alchemy/db.rake

@@ -1,28 +1,12 @@
-require 'shellwords'
-require 'alchemy/seeder'
-require 'alchemy/tasks/helpers'
+# frozen_string_literal: true
+
+require "alchemy/seeder"
 
 namespace :alchemy do
   namespace :db do
-    include Alchemy::Tasks::Helpers
-
     desc "Seeds the database with Alchemy defaults"
     task seed: [:environment] do
       Alchemy::Seeder.seed!
     end
-
-    desc "Dumps the database to STDOUT (Pass DUMP_FILENAME to store the dump into a file)."
-    task dump: :environment do
-      dump_store = ENV['DUMP_FILENAME'] ? " > #{ENV['DUMP_FILENAME']}" : ""
-      dump_cmd = database_dump_command(database_config['adapter'])
-      system "#{dump_cmd}#{dump_store}"
-    end
-
-    desc "Imports the database from STDIN (Pass DUMP_FILENAME to read the dump from file)."
-    task import: :environment do
-      dump_store = ENV['DUMP_FILENAME'] ? "cat #{ENV['DUMP_FILENAME']}" : "echo #{Shellwords.escape(STDIN.read)}"
-      import_cmd = database_import_command(database_config['adapter'])
-      system "#{dump_store} | #{import_cmd}"
-    end
   end
 end

data/lib/tasks/alchemy/install.rake

@@ -1,4 +1,5 @@
-require 'thor'
+# frozen_string_literal: true
+require "thor"
 
 class Alchemy::InstallTask < Thor
   include Thor::Actions
@@ -29,7 +30,7 @@ end
 
 namespace :alchemy do
   desc "Installs Alchemy CMS into your app."
-  task :install do
+  task install: "alchemy:yarn:install" do
     install_helper = Alchemy::InstallTask.new
 
     puts "\nAlchemy Installer"

data/lib/tasks/alchemy/tidy.rake

@@ -1,12 +1,13 @@
-require 'alchemy/tasks/tidy'
+# frozen_string_literal: true
+require "alchemy/tasks/tidy"
 
 namespace :alchemy do
   namespace :tidy do
     desc "Tidy up Alchemy database."
     task :up 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:element_positions"].invoke
+      Rake::Task["alchemy:tidy:content_positions"].invoke
+      Rake::Task["alchemy:tidy:remove_orphaned_records"].invoke
     end
 
     desc "Fixes element positions."
@@ -21,8 +22,8 @@ namespace :alchemy do
 
     desc "Remove orphaned records (elements & contents)."
     task remove_orphaned_records: [:environment] do
-      Rake::Task['alchemy:tidy:remove_orphaned_elements'].invoke
-      Rake::Task['alchemy:tidy:remove_orphaned_contents'].invoke
+      Rake::Task["alchemy:tidy:remove_orphaned_elements"].invoke
+      Rake::Task["alchemy:tidy:remove_orphaned_contents"].invoke
     end
 
     desc "Remove orphaned elements."
@@ -39,7 +40,7 @@ namespace :alchemy do
     task elements_usage: :environment do
       puts "\n"
       removable_elements = []
-      names = Alchemy::Element.definitions.map { |e| e['name'] }
+      names = Alchemy::Element.definitions.map { |e| e["name"] }
       longest_name = names.max_by { |name| name.to_s.length }.length + 1
       names.sort.each do |name|
         names = Alchemy::Element.where(name: name)
@@ -48,7 +49,7 @@ namespace :alchemy do
         if count.zero?
           removable_elements.push(name)
         else
-          spacer = ' ' * (longest_name - name.length)
+          spacer = " " * (longest_name - name.length)
           puts "#{name}#{spacer}is used\t#{count}\ttime(s) on\t#{page_count}\tpublic page(s)"
         end
       end

data/lib/tasks/alchemy/upgrade.rake

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-
 require "alchemy/upgrader"
 require "alchemy/version"
 
@@ -7,10 +6,7 @@ namespace :alchemy do
   desc "Upgrades your app to AlchemyCMS v#{Alchemy::VERSION}."
   task upgrade: [
     "alchemy:upgrade:prepare",
-    "alchemy:upgrade:4.1:run", "alchemy:upgrade:4.1:todo",
-    "alchemy:upgrade:4.2:run", "alchemy:upgrade:4.2:todo",
-    "alchemy:upgrade:4.4:run", "alchemy:upgrade:4.4:todo",
-    "alchemy:upgrade:4.6:run", "alchemy:upgrade:4.6:todo",
+    "alchemy:upgrade:5.0:run",
   ] do
     Alchemy::Upgrader.display_todos
   end
@@ -26,7 +22,6 @@ namespace :alchemy do
     task database: [
       "alchemy:install:migrations",
       "db:migrate",
-      "alchemy:db:seed",
     ]
 
     desc "Alchemy Upgrader: Copy configuration file."
@@ -34,131 +29,34 @@ namespace :alchemy do
       Alchemy::Upgrader.copy_new_config_file
     end
 
-    task fix_picture_format: [:environment] do
-      Alchemy::Picture.find_each do |picture|
-        picture.update_column(:image_file_format, picture.image_file_format.to_s.chomp)
-      end
-    end
-
-    desc "Upgrade Alchemy to v4.1"
-    task "4.1" => [
-      "alchemy:upgrade:prepare",
-      "alchemy:upgrade:4.1:run",
-      "alchemy:upgrade:4.1:todo",
-    ] do
-      Alchemy::Upgrader.display_todos
-    end
-
-    namespace "4.1" do
-      task run: ["alchemy:upgrade:4.1:harden_acts_as_taggable_on_migrations"]
-
-      desc "Harden acts_as_taggable_on migrations"
-      task harden_acts_as_taggable_on_migrations: [:environment] do
-        Alchemy::Upgrader::FourPointOne.harden_acts_as_taggable_on_migrations
-      end
-
-      task :todo do
-        Alchemy::Upgrader::FourPointOne.alchemy_4_1_todos
-      end
-    end
-
-    desc "Upgrade Alchemy to v4.2"
-    task "4.2" => [
-      "alchemy:upgrade:prepare",
-      "alchemy:upgrade:4.2:run",
-      "alchemy:upgrade:4.2:todo",
-    ] do
-      Alchemy::Upgrader.display_todos
-    end
-
-    namespace "4.2" do
-      task run: [
-        "alchemy:upgrade:4.2:convert_picture_galleries",
-        "alchemy:upgrade:4.2:migrate_picture_galleries",
-        "alchemy:upgrade:4.2:convert_cells",
-        "alchemy:upgrade:4.2:migrate_cells",
-        "alchemy:upgrade:4.2:update_element_partial_name_variable",
-      ]
-
-      desc "Convert `picture_gallery` element definitions to `nestable_elements`."
-      task convert_picture_galleries: [:environment] do
-        Alchemy::Upgrader::FourPointTwo.convert_picture_galleries
-      end
-
-      desc "Migrate `picture_gallery` elements to `nestable_elements`."
-      task migrate_picture_galleries: [:environment] do
-        Alchemy::Upgrader::FourPointTwo.migrate_picture_galleries
-      end
-
-      desc "Convert cells config to fixed nestable elements."
-      task convert_cells: [:environment] do
-        Alchemy::Upgrader::FourPointTwo.convert_cells
-      end
-
-      desc "Migrate existing cells to fixed nestable elements."
-      task migrate_cells: ["alchemy:install:migrations", "db:migrate"] do
-        Alchemy::Upgrader::FourPointTwo.migrate_cells
-      end
-
-      desc "Update element views to use element partial name variable."
-      task :update_element_partial_name_variable do
-        Alchemy::Upgrader::FourPointTwo.update_element_views_variable_name
-      end
-
-      task :todo do
-        Alchemy::Upgrader::FourPointTwo.alchemy_4_2_todos
-      end
-    end
-
-    desc "Upgrade Alchemy to v4.4"
-    task "4.4" => [
+    desc "Upgrade Alchemy to v5.0"
+    task "5.0" => [
       "alchemy:upgrade:prepare",
-      "alchemy:upgrade:4.4:run",
-      "alchemy:upgrade:4.4:todo",
+      "alchemy:upgrade:5.0:run",
     ] do
       Alchemy::Upgrader.display_todos
     end
 
-    namespace "4.4" do
-      task run: [
-        "alchemy:upgrade:4.4:rename_element_views",
-        "alchemy:upgrade:4.4:update_local_variable",
+    namespace "5.0" do
+      task "run" => [
+        "alchemy:upgrade:5.0:install_gutentag_migrations",
+        "alchemy:upgrade:5.0:remove_layout_roots",
+        "alchemy:upgrade:5.0:remove_root_page",
       ]
 
-      desc "Remove '_view' suffix from element views."
-      task rename_element_views: [:environment] do
-        Alchemy::Upgrader::FourPointFour.rename_element_views
+      desc "Install Gutentag migrations"
+      task install_gutentag_migrations: [:environment] do
+        Alchemy::Upgrader::FivePointZero.install_gutentag_migrations
       end
 
-      desc "Update element views local variable to element name."
-      task update_local_variable: [:environment] do
-        Alchemy::Upgrader::FourPointFour.update_local_variable
-      end
-
-      task :todo do
-        Alchemy::Upgrader::FourPointFour.alchemy_4_4_todos
-      end
-    end
-
-    desc "Upgrade Alchemy to v4.6"
-    task "4.6" => [
-      "alchemy:upgrade:prepare",
-      "alchemy:upgrade:4.6:run",
-      "alchemy:upgrade:4.6:todo",
-    ] do
-      Alchemy::Upgrader.display_todos
-    end
-
-    namespace "4.6" do
-      task run: []
-
-      desc "Move child pages of invisible pages to visible parent."
-      task restructure_page_tree: [:environment] do
-        Alchemy::Upgrader::FourPointSix.restructure_page_tree
+      desc "Remove layout root pages"
+      task remove_layout_roots: [:environment] do
+        Alchemy::Upgrader::FivePointZero.remove_layout_roots
       end
 
-      task :todo do
-        Alchemy::Upgrader::FourPointSix.alchemy_4_6_todos
+      desc "Remove root page"
+      task remove_root_page: [:environment] do
+        Alchemy::Upgrader::FivePointZero.remove_root_page
       end
     end
   end

data/package/admin.js

@@ -0,0 +1,14 @@
+import translate from "./src/i18n"
+import NodeTree from "./src/node_tree"
+
+// Global Alchemy object
+if (typeof window.Alchemy === "undefined") {
+  window.Alchemy = {}
+}
+
+// Enhance the global Alchemy object with imported features
+Object.assign(Alchemy, {
+  // Global utility method for translating a given string
+  t: translate,
+  NodeTree
+})