alchemy_cms 4.4.4 → 4.6.3

data/config/routes.rb

@@ -17,11 +17,7 @@ Alchemy::Engine.routes.draw do
   namespace :admin, {path: Alchemy.admin_path, constraints: Alchemy.admin_constraints} do
     resources :contents, only: [:create]
 
-    resources :nodes do
-      member do
-        patch :toggle
-      end
-    end
+    resources :nodes
 
     resources :pages do
       resources :elements
@@ -152,6 +148,13 @@ Alchemy::Engine.routes.draw do
 
     get '/pages/*urlname(.:format)' => 'pages#show', as: 'page'
     get '/admin/pages/:id(.:format)' => 'pages#show', as: 'preview_page'
+
+    resources :nodes, only: [] do
+      member do
+        patch :move
+        patch :toggle_folded
+      end
+    end
   end
 
   get '/:locale' => 'pages#index',

data/lib/alchemy/config.rb

@@ -8,8 +8,10 @@ module Alchemy
       # @param name [String]
       #
       def get(name)
+        check_deprecation(name)
         show[name.to_s]
       end
+
       alias_method :parameter, :get
 
       # Returns a merged configuration of the following files
@@ -25,11 +27,22 @@ module Alchemy
         @config ||= merge_configs!(alchemy_config, main_app_config, env_specific_config)
       end
 
+      # A list of deprecated configurations
+      # a value of nil means there is no new default
+      # any not nil value is the new default
+      def deprecated_configs
+        {
+          url_nesting: true,
+          require_ssl: nil,
+          auto_logout_time: nil,
+        }
+      end
+
       private
 
       # Alchemy default configuration
       def alchemy_config
-        read_file(File.join(File.dirname(__FILE__), '..', '..', 'config/alchemy/config.yml'))
+        read_file(File.join(File.dirname(__FILE__), "..", "..", "config/alchemy/config.yml"))
       end
 
       # Application specific configuration
@@ -54,11 +67,26 @@ module Alchemy
       # Merges all given configs together
       #
       def merge_configs!(*config_files)
-        raise LoadError, 'No Alchemy config file found!' if config_files.map(&:blank?).all?
+        raise LoadError, "No Alchemy config file found!" if config_files.map(&:blank?).all?
+
         config = {}
         config_files.each { |h| config.merge!(h.stringify_keys!) }
         config
       end
+
+      def check_deprecation(name)
+        if deprecated_configs.key?(name.to_sym)
+          config = deprecated_configs[name.to_sym]
+          if config.nil?
+            Alchemy::Deprecation.warn("#{name} configuration is deprecated and will be removed from Alchemy 5.0")
+          else
+            value = show[name.to_s]
+            if value != config
+              Alchemy::Deprecation.warn("Setting #{name} configuration to #{value} is deprecated and will be always #{config} in Alchemy 5.0")
+            end
+          end
+        end
+      end
     end
   end
 end

data/lib/alchemy/resource.rb

@@ -131,21 +131,23 @@ module Alchemy
     end
 
     def namespaced_resource_name
-      @_namespaced_resource_name ||= namespaced_resources_name.singularize
+      @_namespaced_resource_name ||= begin
+        namespaced_resources_name.to_s.singularize
+      end.to_sym # Rails >= 6.0.3.7 needs symbols in polymorphic routes
     end
 
     def namespaced_resources_name
       @_namespaced_resources_name ||= begin
         resource_name_array = resource_array.dup
         resource_name_array.delete(engine_name) if in_engine?
-        resource_name_array.join('_')
-      end
+        resource_name_array.join("_")
+      end.to_sym # Rails >= 6.0.3.7 needs symbols in polymorphic routes
     end
 
     def namespace_for_scope
       namespace_array = namespace_diff
       namespace_array.delete(engine_name) if in_engine?
-      namespace_array
+      namespace_array.map(&:to_sym) # Rails >= 6.0.3.7 needs symbols in polymorphic routes
     end
 
     # Returns an array of underscored association names

data/lib/alchemy/ssl_protection.rb

@@ -26,7 +26,9 @@ module Alchemy
 
     # Redirects current request to https.
     def enforce_ssl
-      redirect_to url_for(request.params.merge(protocol: 'https'))
+      redirect_to url_for(request.params.merge(protocol: "https"))
     end
+
+    deprecate :enforce_ssl, deprecator: Alchemy::Deprecation
   end
 end

data/lib/alchemy/upgrader/four_point_six.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Alchemy
+  class Upgrader::FourPointSix < Upgrader
+    class << self
+      def alchemy_4_6_todos
+        notice = <<-NOTE.strip_heredoc
+
+          ℹ️  Page visible attribute is deprecated
+          ----------------------------------------
+
+          Page slugs will be visible in URLs of child pages all the time in the future.
+          Please use Menus and Tags instead to re-organize your pages if your page tree does not reflect the URL hierarchy.
+
+          A rake task to help with the migration is available.
+
+              bin/rake alchemy:upgrade:4.6:restructure_page_tree
+
+        NOTE
+        todo notice, "Alchemy v4.6 TODO"
+      end
+
+      def restructure_page_tree
+        desc "Move child pages of invisible pages to visible parent."
+        Alchemy::Deprecation.silence do
+          # All leaves can safely be marked visible
+          Alchemy::Page.leaves.update_all(visible: true)
+          Alchemy::Page.language_roots.each do |root_page|
+            # Root pages are always visible
+            root_page.update!(visible: true)
+            remove_invisible_children(root_page)
+          end
+          Alchemy::Page.update_all(visible: true)
+        end
+      end
+
+      private
+
+      def remove_invisible_children(page)
+        page.children.each { |child| remove_invisible_children(child) }
+        if !page.visible
+          page.children.reload.reverse.each do |child|
+            puts "Moving #{child.urlname} to right of #{page.urlname}"
+            child.move_to_right_of(page)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/alchemy/version.rb

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

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

@@ -17,7 +17,7 @@ module Alchemy
       end
 
       def copy_yml_files
-        %w(elements page_layouts).each do |file|
+        %w(elements page_layouts menus).each do |file|
           template "#{__dir__}/templates/#{file}.yml.tt", "config/alchemy/#{file}.yml"
         end
       end

data/lib/rails/generators/alchemy/install/templates/menus.yml.tt

@@ -0,0 +1,8 @@
+# == In this configuration, you set up Alchemy's menu names.
+#
+# For further information please see http://guides.alchemy-cms.com/stable/menus.html
+
+<%- unless @options[:skip_demo_files] -%>
+- main_menu
+- footer_menu
+<%- end -%>

data/lib/rails/generators/alchemy/menus/menus_generator.rb

@@ -9,14 +9,14 @@ module Alchemy
       source_root File.expand_path('templates', __dir__)
 
       def create_partials
-        menus = Alchemy::Node.roots
+        menus = Alchemy::Node.available_menu_names
         return unless menus
 
         menus.each do |menu|
           conditional_template "wrapper.html.#{template_engine}",
-            "app/views/#{menu.view_folder_name}/_wrapper.html.#{template_engine}"
+            "app/views/alchemy/menus/#{menu}/_wrapper.html.#{template_engine}"
           conditional_template "node.html.#{template_engine}",
-            "app/views/#{menu.view_folder_name}/_node.html.#{template_engine}"
+            "app/views/alchemy/menus/#{menu}/_node.html.#{template_engine}"
         end
       end
     end

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

@@ -3,4 +3,4 @@
     = render partial: options[:node_partial_name],
       collection: menu.children.includes(:page, :children),
       locals: { options: options },
-      as: 'node' %>
+      as: 'node'

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

@@ -3,4 +3,4 @@
     = render partial: options[:node_partial_name],
       collection: menu.children.includes(:page, :children),
       locals: { options: options },
-      as: 'node' %>
+      as: 'node'

data/lib/tasks/alchemy/convert.rake

@@ -3,6 +3,7 @@ namespace :alchemy do
     namespace :urlnames do
       desc "Converts the urlname of all pages to nested url paths."
       task to_nested: [:environment] do
+        Alchemy::Deprecation.warn('alchemy:convert:urlnames:to_nested task is deprecated and will be removed from Alchemy 5.0')
         unless Alchemy::Config.get(:url_nesting)
           raise "\nURL nesting is disabled! Please enable url_nesting in `config/alchemy/config.yml` first.\n\n"
         end
@@ -18,6 +19,7 @@ namespace :alchemy do
 
       desc "Converts the urlname of all pages to contain the slug only."
       task to_slug: [:environment] do
+        Alchemy::Deprecation.warn('alchemy:convert:urlnames:to_slug task is deprecated and will be removed from Alchemy 5.0')
         if Alchemy::Config.get(:url_nesting)
           raise "\nURL nesting is enabled! Please disable url_nesting in `config/alchemy/config.yml` first.\n\n"
         end
@@ -58,15 +60,17 @@ namespace :alchemy do
         def convert_to_nodes(children, node:)
           children.each do |page|
             has_children = page.children.any?
-            next unless page.visible || has_children
 
             Alchemy::Deprecation.silence do
+              next unless page.visible || has_children
+
               new_node = node.children.create!(
                 name: name_for_node(page),
                 page: page_for_node(page),
-                url: page.definition['redirects_to_external'] ? page.urlname : nil,
-                external: page.definition['redirects_to_external'] && Alchemy::Config.get(:open_external_links_in_new_tab),
-                language_id: page.language_id
+                url: !!page.definition['redirects_to_external'] ? page.urlname : nil,
+                external: !!page.definition['redirects_to_external'] && Alchemy::Config.get(:open_external_links_in_new_tab),
+                language_id: page.language_id,
+                site_id: page.language.site_id
               )
               print "."
               if has_children
@@ -80,9 +84,8 @@ namespace :alchemy do
         puts "\n- Converting #{menu_count} page #{'tree'.pluralize(menu_count)} into #{'menu'.pluralize(menu_count)}."
         Alchemy::BaseRecord.transaction do
           Alchemy::Language.all.each do |language|
-            locale = language.locale.presence || I18n.default_locale
-            menu_name = I18n.t('Main Navigation', scope: 'alchemy.menu_names', default: 'Main Navigation', locale: locale)
-            root_node = Alchemy::Node.create(language: language, name: menu_name)
+            menu_name = 'main_menu'
+            root_node = Alchemy::Node.create(language: language, name: menu_name, site: language.site, external: false)
             language.pages.language_roots.each do |root_page|
               convert_to_nodes(root_page.children, node: root_node)
             end

data/lib/tasks/alchemy/upgrade.rake

@@ -1,29 +1,32 @@
-require 'alchemy/upgrader'
-require 'alchemy/version'
+# frozen_string_literal: true
+
+require "alchemy/upgrader"
+require "alchemy/version"
 
 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: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",
   ] do
     Alchemy::Upgrader.display_todos
   end
 
   namespace :upgrade do
-    desc 'Alchemy Upgrader: Prepares the database and updates Alchemys configuration file.'
+    desc "Alchemy Upgrader: Prepares the database and updates Alchemys configuration file."
     task prepare: [
-      'alchemy:upgrade:database',
-      'alchemy:upgrade:config'
+      "alchemy:upgrade:database",
+      "alchemy:upgrade:config",
     ]
 
     desc "Alchemy Upgrader: Prepares the database."
     task database: [
-      'alchemy:install:migrations',
-      'db:migrate',
-      'alchemy:db:seed'
+      "alchemy:install:migrations",
+      "db:migrate",
+      "alchemy:db:seed",
     ]
 
     desc "Alchemy Upgrader: Copy configuration file."
@@ -37,19 +40,19 @@ namespace :alchemy do
       end
     end
 
-    desc 'Upgrade Alchemy to v4.1'
-    task '4.1' => [
-      'alchemy:upgrade:prepare',
-      'alchemy:upgrade:4.1:run',
-      'alchemy:upgrade:4.1:todo'
+    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']
+    namespace "4.1" do
+      task run: ["alchemy:upgrade:4.1:harden_acts_as_taggable_on_migrations"]
 
-      desc '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
@@ -59,45 +62,45 @@ namespace :alchemy do
       end
     end
 
-    desc 'Upgrade Alchemy to v4.2'
-    task '4.2' => [
-      'alchemy:upgrade:prepare',
-      'alchemy:upgrade:4.2:run',
-      'alchemy:upgrade:4.2:todo'
+    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
+    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'
+        "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`.'
+      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`.'
+      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.'
+      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
+      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.'
+      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
@@ -107,19 +110,19 @@ namespace :alchemy do
       end
     end
 
-    desc 'Upgrade Alchemy to v4.4'
-    task '4.4' => [
-      'alchemy:upgrade:prepare',
-      'alchemy:upgrade:4.4:run',
-      'alchemy:upgrade:4.4:todo'
+    desc "Upgrade Alchemy to v4.4"
+    task "4.4" => [
+      "alchemy:upgrade:prepare",
+      "alchemy:upgrade:4.4:run",
+      "alchemy:upgrade:4.4:todo",
     ] do
       Alchemy::Upgrader.display_todos
     end
 
-    namespace '4.4' do
+    namespace "4.4" do
       task run: [
-        'alchemy:upgrade:4.4:rename_element_views',
-        'alchemy:upgrade:4.4:update_local_variable'
+        "alchemy:upgrade:4.4:rename_element_views",
+        "alchemy:upgrade:4.4:update_local_variable",
       ]
 
       desc "Remove '_view' suffix from element views."
@@ -127,7 +130,7 @@ namespace :alchemy do
         Alchemy::Upgrader::FourPointFour.rename_element_views
       end
 
-      desc 'Update element views local variable to element name.'
+      desc "Update element views local variable to element name."
       task update_local_variable: [:environment] do
         Alchemy::Upgrader::FourPointFour.update_local_variable
       end
@@ -136,5 +139,27 @@ namespace :alchemy 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
+      end
+
+      task :todo do
+        Alchemy::Upgrader::FourPointSix.alchemy_4_6_todos
+      end
+    end
   end
 end