alchemy_cms 4.6.1 → 5.0.0

data/lib/alchemy/upgrader.rb

@@ -1,26 +1,27 @@
-require 'alchemy/shell'
+# frozen_string_literal: true
+require "alchemy/shell"
 
 module Alchemy
   class Upgrader
     extend Alchemy::Shell
 
-    Dir["#{File.dirname(__FILE__)}/upgrader/*.rb"].each { |f| require f }
+    Dir["#{File.dirname(__FILE__)}/upgrader/*.rb"].sort.each { |f| require f }
 
     class << self
       def copy_new_config_file
         desc "Copy configuration file."
-        config_file = Rails.root.join('config/alchemy/config.yml')
-        default_config = File.join(File.dirname(__FILE__), '../../config/alchemy/config.yml')
+        config_file = Rails.root.join("config/alchemy/config.yml")
+        default_config = File.join(File.dirname(__FILE__), "../../config/alchemy/config.yml")
         if !File.exist? config_file
           log "No configuration file found. Creating it."
-          FileUtils.cp default_config, Rails.root.join('config/alchemy/config.yml')
+          FileUtils.cp default_config, Rails.root.join("config/alchemy/config.yml")
         elsif FileUtils.identical? default_config, config_file
           log "Configuration file already present.", :skip
         else
           log "Custom configuration file found."
-          FileUtils.cp default_config, Rails.root.join('config/alchemy/config.yml.defaults')
+          FileUtils.cp default_config, Rails.root.join("config/alchemy/config.yml.defaults")
           log "Copied new default configuration file."
-          todo "Check the default configuration file (./config/alchemy/config.yml.defaults) for new configuration options and insert them into your config file.", 'Configuration has changed'
+          todo "Check the default configuration file (./config/alchemy/config.yml.defaults) for new configuration options and insert them into your config file.", "Configuration has changed"
         end
       end
     end

data/lib/alchemy/upgrader/five_point_zero.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require_relative "tasks/harden_gutentag_migrations"
+
+module Alchemy
+  class Upgrader::FivePointZero < Upgrader
+    class << self
+      def install_gutentag_migrations
+        desc "Install Gutentag migrations"
+        Rake::Task["gutentag:install:migrations"].invoke
+        Alchemy::Upgrader::Tasks::HardenGutentagMigrations.new.patch_migrations
+        Rake::Task["db:migrate"].invoke
+      end
+
+      def remove_layout_roots
+        desc "Remove layout root pages"
+        layout_roots = Alchemy::Page.where(layoutpage: true).where("name LIKE 'Layoutroot for%'")
+        if layout_roots.size.positive?
+          log "Removing #{layout_roots.size} layout root pages."
+          layout_roots.delete_all
+          Alchemy::Page.where(layoutpage: true).update_all(parent_id: nil)
+          log "Done.", :success
+        else
+          log "No layout root pages found.", :skip
+        end
+      end
+
+      def remove_root_page
+        desc "Remove root page"
+        root_page = Alchemy::Page.find_by(parent_id: nil, name: "Root")
+        if root_page
+          Alchemy::Page.where(parent_id: root_page.id).update_all(parent_id: nil)
+          root_page.delete
+          log "Done.", :success
+        else
+          log "Root page not found.", :skip
+        end
+      end
+    end
+  end
+end

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'alchemy/upgrader'
+require "alchemy/upgrader"
 
 module Alchemy::Upgrader::Tasks
   class ElementViewsUpdater < Thor
@@ -11,14 +11,14 @@ module Alchemy::Upgrader::Tasks
         puts "-- Removing '_view' suffix from element views"
 
         Dir.glob("#{elements_view_folder}/*_view.*").each do |file|
-          FileUtils.mv(file, file.to_s.sub(/_view/, ''))
+          FileUtils.mv(file, file.to_s.sub(/_view/, ""))
         end
       end
 
       def update_local_variable
         puts "-- Updating element views local variable to element name"
 
-        Alchemy::Element.definitions.map { |e| e['name'] }.each do |name|
+        Alchemy::Element.definitions.map { |e| e["name"] }.each do |name|
           view = Dir.glob("#{elements_view_folder}/_#{name}.*").last
           gsub_file(view, /\b#{name}_view\b/, name)
         end
@@ -28,7 +28,7 @@ module Alchemy::Upgrader::Tasks
     private
 
     def elements_view_folder
-      Rails.root.join('app', 'views', 'alchemy', 'elements')
+      Rails.root.join("app", "views", "alchemy", "elements")
     end
   end
 end

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

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require "thor"
+
+module Alchemy::Upgrader::Tasks
+  class HardenGutentagMigrations < Thor
+    include Thor::Actions
+
+    no_tasks do
+      def patch_migrations
+        sentinel = /def up/
+
+        migration_file = Dir.glob("db/migrate/*_gutentag_tables.gutentag.rb").first
+        if migration_file
+          inject_into_file migration_file,
+            "\n    # inserted by Alchemy CMS upgrader\n    return if table_exists?(:gutentag_taggings)\n",
+            { after: sentinel, verbose: true }
+        end
+
+        migration_file = Dir.glob("db/migrate/*_gutentag_cache_counter.gutentag.rb").first
+        if migration_file
+          inject_into_file migration_file,
+            "\n    # inserted by Alchemy CMS upgrader\n    return if column_exists?(:gutentag_tags, :taggings_count)\n",
+            { after: sentinel, verbose: true }
+        end
+      end
+    end
+  end
+end

data/lib/alchemy/version.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module Alchemy
-  VERSION = "4.6.1"
+  VERSION = "5.0.0"
 
   def self.version
     VERSION

data/lib/alchemy_cms.rb

@@ -1,61 +1,63 @@
+# frozen_string_literal: true
 # Instantiate the global Alchemy namespace
 module Alchemy
-  Alchemy::YAML_WHITELIST_CLASSES = %w(Symbol Date Regexp)
+  YAML_WHITELIST_CLASSES = %w(Symbol Date Regexp)
 end
 
 # Require globally used external libraries
-require 'acts_as_list'
-require 'action_view/dependency_tracker'
-require 'active_model_serializers'
-require 'awesome_nested_set'
-require 'cancan'
-require 'dragonfly'
-require 'gutentag'
-require 'handlebars_assets'
-require 'jquery-rails'
-require 'jquery-ui-rails'
-require 'kaminari'
-require 'non-stupid-digest-assets'
-require 'ransack'
-require 'request_store'
-require 'responders'
-require 'sassc-rails'
-require 'simple_form'
-require 'select2-rails'
-require 'turbolinks'
-require 'userstamp'
+require "acts_as_list"
+require "action_view/dependency_tracker"
+require "active_model_serializers"
+require "awesome_nested_set"
+require "cancan"
+require "dragonfly"
+require "gutentag"
+require "handlebars_assets"
+require "jquery-rails"
+require "jquery-ui-rails"
+require "kaminari"
+require "non-stupid-digest-assets"
+require "ransack"
+require "request_store"
+require "responders"
+require "sassc-rails"
+require "simple_form"
+require "select2-rails"
+require "turbolinks"
+require "userstamp"
+require "webpacker"
 
 # Require globally used Alchemy mixins
-require_relative 'alchemy/ability_helper'
-require_relative 'alchemy/admin/locale'
-require_relative 'alchemy/auth_accessors'
-require_relative 'alchemy/cache_digests/template_tracker'
-require_relative 'alchemy/config'
-require_relative 'alchemy/configuration_methods'
-require_relative 'alchemy/controller_actions'
-require_relative 'alchemy/deprecation'
-require_relative 'alchemy/elements_finder'
-require_relative 'alchemy/errors'
-require_relative 'alchemy/essence'
-require_relative 'alchemy/filetypes'
-require_relative 'alchemy/forms/builder'
-require_relative 'alchemy/hints'
-require_relative 'alchemy/i18n'
-require_relative 'alchemy/logger'
-require_relative 'alchemy/modules'
-require_relative 'alchemy/name_conversions'
-require_relative 'alchemy/on_page_layout'
-require_relative 'alchemy/on_page_layout/callbacks_runner'
-require_relative 'alchemy/page_layout'
-require_relative 'alchemy/paths'
-require_relative 'alchemy/permissions'
-require_relative 'alchemy/ssl_protection'
-require_relative 'alchemy/resource'
-require_relative 'alchemy/tinymce'
-require_relative 'alchemy/taggable'
+require_relative "alchemy/ability_helper"
+require_relative "alchemy/admin/locale"
+require_relative "alchemy/admin/preview_url"
+require_relative "alchemy/auth_accessors"
+require_relative "alchemy/cache_digests/template_tracker"
+require_relative "alchemy/config"
+require_relative "alchemy/configuration_methods"
+require_relative "alchemy/controller_actions"
+require_relative "alchemy/deprecation"
+require_relative "alchemy/elements_finder"
+require_relative "alchemy/errors"
+require_relative "alchemy/essence"
+require_relative "alchemy/filetypes"
+require_relative "alchemy/forms/builder"
+require_relative "alchemy/hints"
+require_relative "alchemy/i18n"
+require_relative "alchemy/logger"
+require_relative "alchemy/modules"
+require_relative "alchemy/name_conversions"
+require_relative "alchemy/on_page_layout"
+require_relative "alchemy/on_page_layout/callbacks_runner"
+require_relative "alchemy/page_layout"
+require_relative "alchemy/paths"
+require_relative "alchemy/permissions"
+require_relative "alchemy/resource"
+require_relative "alchemy/tinymce"
+require_relative "alchemy/taggable"
 
 # Require hacks
-require_relative 'kaminari/scoped_pagination_url_helper'
+require_relative "kaminari/scoped_pagination_url_helper"
 
 # Finally require Alchemy itself
-require_relative 'alchemy/engine'
+require_relative "alchemy/engine"

data/lib/{rails/generators → generators}/alchemy/base.rb

@@ -1,14 +1,15 @@
-require 'rails'
+# frozen_string_literal: true
+require "rails"
 
 module Alchemy
   module Generators
     class Base < ::Rails::Generators::Base
-      class_option :template_engine, type: :string, aliases: '-e', desc: 'Template engine for the views. Available options are "erb", "haml", and "slim".'
+      class_option :template_engine, type: :string, aliases: "-e", desc: 'Template engine for the views. Available options are "erb", "haml", and "slim".'
 
       private
 
       def conditional_template(source, destination)
-        files = Dir.glob(destination.gsub(/\.([a-z]+)$/, '*'))
+        files = Dir.glob(destination.gsub(/\.([a-z]+)$/, "*"))
         if files.any?
           ext = File.extname(files.first)[1..-1]
 
@@ -28,7 +29,7 @@ module Alchemy
         # Rails is clever enough to default this to whatever template
         # engine is configured through its generator configuration,
         # but we'll default it to erb anyway, just in case.
-        options[:template_engine] || 'erb'
+        options[:template_engine] || "erb"
       end
 
       def load_alchemy_yaml(name)

data/lib/{rails/generators → generators}/alchemy/elements/elements_generator.rb

@@ -1,24 +1,20 @@
-require_relative '../base'
+# frozen_string_literal: true
+require_relative "../base"
 
 module Alchemy
   module Generators
     class ElementsGenerator < Base
       desc "This generator generates your elements view partials."
-      source_root File.expand_path('templates', __dir__)
+      source_root File.expand_path("templates", __dir__)
 
       def create_partials
-        @elements = load_alchemy_yaml('elements.yml')
+        @elements = load_alchemy_yaml("elements.yml")
         return unless @elements
 
         @elements.each do |element|
           @element = element
           @contents = element["contents"] || []
-          if element["name"] =~ /\A[a-z0-9_-]+\z/
-            @element_name = element["name"].underscore
-          else
-            raise "Element name '#{element['name']}' has wrong format. Only lowercase and non whitespace characters allowed."
-          end
-
+          @element_name = element_name(element)
           conditional_template "view.html.#{template_engine}", "#{elements_dir}/_#{@element_name}.html.#{template_engine}"
         end
       end
@@ -28,6 +24,14 @@ module Alchemy
       def elements_dir
         @_elements_dir ||= "app/views/alchemy/elements"
       end
+
+      def element_name(element)
+        if element["name"] =~ Alchemy::Element::NAME_REGEXP
+          element["name"].underscore
+        else
+          raise "Element name '#{element["name"]}' has wrong format. Only lowercase and non whitespace characters allowed."
+        end
+      end
     end
   end
 end

data/lib/{rails/generators → generators}/alchemy/essence/essence_generator.rb

@@ -1,15 +1,16 @@
-require 'rails'
+# frozen_string_literal: true
+require "rails"
 
 module Alchemy
   module Generators
     class EssenceGenerator < ::Rails::Generators::Base
       desc "This generator generates an Alchemy essence for you."
       argument :essence_name, banner: "YourEssenceName"
-      source_root File.expand_path('templates', __dir__)
+      source_root File.expand_path("templates", __dir__)
 
       def init
         @essence_name = essence_name.underscore
-        @essence_view_path = 'app/views/alchemy/essences'
+        @essence_view_path = "app/views/alchemy/essences"
       end
 
       def create_model
@@ -19,20 +20,21 @@ module Alchemy
       def act_as_essence
         essence_class_file = "app/models/#{@essence_name}.rb"
         essence_class = @essence_name.classify
-        inject_into_class essence_class_file, essence_class, <<-CLASSMETHOD
-  acts_as_essence(
-    # Your options:
-    #
-    # ingredient_column:   [String or Symbol] - Specifies the column name you use for storing the content in the database. (Default :body)
-    # validate_column:     [String or Symbol] - Which column should be validated. (Default: ingredient_column)
-    # preview_text_column: [String or Symbol] - Specifies the column for the preview_text method. (Default: ingredient_column)
-    # preview_text_method: [String or Symbol] - A method called on ingredient to get the preview text. (Default: ingredient_column)
-  )
-CLASSMETHOD
+        inject_into_class essence_class_file, essence_class, <<~CLASSMETHOD
+          acts_as_essence(
+            # Your options:
+            #
+            # ingredient_column:   [String or Symbol] - Specifies the column name you use for storing the content in the database. (Default :body)
+            # validate_column:     [String or Symbol] - Which column should be validated. (Default: ingredient_column)
+            # preview_text_column: [String or Symbol] - Specifies the column for the preview_text method. (Default: ingredient_column)
+            # preview_text_method: [String or Symbol] - A method called on ingredient to get the preview text. (Default: ingredient_column)
+          )
+        CLASSMETHOD
       end
 
       def copy_templates
         essence_name = @essence_name.classify.demodulize.underscore
+        @essence_editor_local = "#{essence_name}_editor"
         template "view.html.erb", "#{@essence_view_path}/_#{essence_name}_view.html.erb"
         template "editor.html.erb", "#{@essence_view_path}/_#{essence_name}_editor.html.erb"
       end

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

@@ -0,0 +1,17 @@
+<%%#
+  Available locals:
+  * <%= @essence_editor_local %> - A Alchemy::ContentEditor instance
+
+  Please consult Alchemy::Content.rb docs for further methods on the content object
+%>
+<%%= content_tag :div,
+  id: <%= @essence_editor_local %>.dom_id,
+  class: <%= @essence_editor_local %>.css_classes,
+  data: <%= @essence_editor_local %>.data_attributes do %>
+  <%%= content_label(<%= @essence_editor_local %>) %>
+  <%%= text_field_tag(
+    <%= @essence_editor_local %>.form_field_name,
+    <%= @essence_editor_local %>.ingredient,
+    id: <%= @essence_editor_local %>.form_field_id
+  ) %>
+<%% end %>

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,169 @@
+# frozen_string_literal: true
+require "rails/generators"
+require "alchemy/install/tasks"
+
+module Alchemy
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      desc "Installs Alchemy into your App."
+
+      class_option :auto_accept,
+        type: :boolean,
+        default: false,
+        desc: "Automatically accept defaults."
+
+      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 setup
+        header
+        say "Welcome to AlchemyCMS!"
+        say "Let's begin with some questions.\n\n"
+        install_tasks.inject_routes(options[:auto_accept])
+      end
+
+      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"),
+          skip: options[:auto_accept]
+        )
+      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
+
+      def set_primary_language
+        header
+        install_tasks.set_primary_language(options[:auto_accept])
+      end
+
+      def setup_database
+        rake("db:create", abort_on_failure: true)
+        # 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)
+        install_tasks.inject_seeder
+        rake("db:seed", abort_on_failure: true)
+      end
+
+      def finalize
+        header
+        say "Alchemy successfully installed!"
+        say "Now start the server with:\n\n"
+        say "  bin/rails server\n\n"
+        say "and point your browser to\n\n"
+        say "  http://localhost:3000/admin\n\n"
+        say "and follow the onscreen instructions to finalize the installation.\n\n"
+      end
+
+      private
+
+      def header
+        return if options[:auto_accept]
+
+        puts "─────────────────────"
+        puts "* Alchemy Installer *"
+        puts "─────────────────────"
+      end
+
+      def say(something)
+        return if options[:auto_accept]
+
+        puts "  #{something}"
+      end
+
+      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
+
+      def install_tasks
+        @_install_tasks ||= Alchemy::Install::Tasks.new
+      end
+    end
+  end
+end