alchemy_cms 4.1.2 → 4.2.0.rc1

data/lib/alchemy/test_support/factories/essence_text_factory.rb

@@ -2,6 +2,6 @@ require 'factory_bot'
 
 FactoryBot.define do
   factory :alchemy_essence_text, class: 'Alchemy::EssenceText' do
-    body 'This is a headline'
+    body { 'This is a headline' }
   end
 end

data/lib/alchemy/test_support/factories/language_factory.rb

@@ -3,26 +3,26 @@ require 'alchemy/test_support/factories/site_factory'
 
 FactoryBot.define do
   factory :alchemy_language, class: 'Alchemy::Language' do
-    name 'Deutsch'
-    code 'de'
-    default true
-    frontpage_name 'Intro'
+    name { 'Deutsch' }
+    code { 'de' }
+    default { true }
+    frontpage_name { 'Intro' }
     page_layout { Alchemy::Config.get(:default_language)['page_layout'] }
-    public true
+    public { true }
     site { Alchemy::Site.default }
 
     trait :klingon do
-      name 'Klingon'
-      code 'kl'
-      frontpage_name 'Tuq'
-      default false
+      name { 'Klingon' }
+      code { 'kl' }
+      frontpage_name { 'Tuq' }
+      default { false }
     end
 
     trait :english do
-      name 'English'
-      code 'en'
-      frontpage_name 'Intro'
-      default false
+      name { 'English' }
+      code { 'en' }
+      frontpage_name { 'Intro' }
+      default { false }
     end
   end
 end

data/lib/alchemy/test_support/factories/page_factory.rb

@@ -5,7 +5,7 @@ FactoryBot.define do
   factory :alchemy_page, class: 'Alchemy::Page' do
     language { Alchemy::Language.default || FactoryBot.create(:alchemy_language) }
     sequence(:name) { |n| "A Page #{n}" }
-    page_layout "standard"
+    page_layout { "standard" }
 
     parent_id do
       (Alchemy::Page.find_by(language_root: true) ||
@@ -13,20 +13,20 @@ FactoryBot.define do
     end
 
     # This speeds up creating of pages dramatically.
-    # Pass do_not_autogenerate: false to generate elements
-    do_not_autogenerate true
+    # Pass autogenerate_elements: true to generate elements
+    autogenerate_elements { false }
 
     trait :root do
-      name 'Root'
-      language nil
-      parent_id nil
-      page_layout nil
+      name { 'Root' }
+      language { nil }
+      parent_id { nil }
+      page_layout { nil }
     end
 
     trait :language_root do
-      name 'Startseite'
+      name { 'Startseite' }
       page_layout { language.page_layout }
-      language_root true
+      language_root { true }
       public_on { Time.current }
       parent_id { Alchemy::Page.root.id }
     end
@@ -37,22 +37,23 @@ FactoryBot.define do
     end
 
     trait :system do
-      name "Systempage"
+      name { "Systempage" }
       parent_id { Alchemy::Page.root.id }
-      language_root false
-      page_layout nil
-      language nil
+      language_root { false }
+      page_layout { nil }
+      language { nil }
     end
 
     trait :layoutpage do
-      name "Footer"
+      name { "Footer" }
       parent_id { Alchemy::Page.find_or_create_layout_root_for(Alchemy::Language.current.id).id }
-      page_layout "footer"
+      layoutpage { true }
+      page_layout { "footer" }
     end
 
     trait :restricted do
-      name "Restricted page"
-      restricted true
+      name { "Restricted page" }
+      restricted { true }
     end
 
     trait :locked do

data/lib/alchemy/test_support/factories/picture_factory.rb

@@ -2,9 +2,11 @@ require 'factory_bot'
 
 FactoryBot.define do
   factory :alchemy_picture, class: 'Alchemy::Picture' do
-    image_file File.new(Alchemy::Engine.root.join('lib', 'alchemy', 'test_support', 'fixtures', 'image.png'))
-    name 'image'
-    image_file_name 'image.png'
-    upload_hash Time.current.hash
+    image_file do
+      File.new(Alchemy::Engine.root.join('lib', 'alchemy', 'test_support', 'fixtures', 'image.png'))
+    end
+    name { 'image' }
+    image_file_name { 'image.png' }
+    upload_hash { Time.current.hash }
   end
 end

data/lib/alchemy/test_support/factories/site_factory.rb

@@ -2,17 +2,17 @@ require 'factory_bot'
 
 FactoryBot.define do
   factory :alchemy_site, class: 'Alchemy::Site' do
-    name 'A Site'
-    host 'domain.com'
+    name { 'A Site' }
+    host { 'domain.com' }
 
     trait :default do
-      public true
-      name Alchemy::Config.get(:default_site)['name']
-      host Alchemy::Config.get(:default_site)['host']
+      public { true }
+      name { Alchemy::Config.get(:default_site)['name'] }
+      host { Alchemy::Config.get(:default_site)['host'] }
     end
 
     trait :public do
-      public true
+      public { true }
     end
   end
 end

data/lib/alchemy/tinymce.rb

@@ -4,7 +4,7 @@ module Alchemy
   module Tinymce
     mattr_accessor :languages, :plugins
 
-    @@plugins = %w(alchemy_link anchor autoresize charmap code directionality fullscreen hr link paste tabfocus table)
+    @@plugins = %w(alchemy_link anchor autoresize charmap code directionality fullscreen hr link lists paste tabfocus table)
     @@init = {
       skin: 'alchemy',
       width: 'auto',

data/lib/alchemy/upgrader/four_point_two.rb

@@ -0,0 +1,68 @@
+require_relative 'tasks/picture_gallery_upgrader'
+require_relative 'tasks/picture_gallery_migration'
+require_relative 'tasks/cells_upgrader'
+require_relative 'tasks/cells_migration'
+
+module Alchemy
+  class Upgrader::FourPointTwo < Upgrader
+    class << self
+      def convert_picture_galleries
+        desc 'Convert `picture_gallery` element definitions to `nestable_elements`.'
+        Alchemy::Upgrader::Tasks::PictureGalleryUpgrader.new.convert_picture_galleries
+      end
+
+      def migrate_picture_galleries
+        desc 'Migrate existing gallery elements to `nestable_elements`.'
+        Alchemy::Upgrader::Tasks::PictureGalleryMigration.new.migrate_picture_galleries
+      end
+
+      def convert_cells
+        desc 'Convert cells config to fixed nestable elements.'
+        Alchemy::Upgrader::Tasks::CellsUpgrader.new.convert_cells
+      end
+
+      def migrate_cells
+        desc 'Migrate existing cells to fixed nestable elements.'
+        Alchemy::Upgrader::Tasks::CellsMigration.new.migrate_cells
+      end
+
+      def alchemy_4_2_todos
+        notice = <<-NOTE
+
+        Element's "picture_gallery" feature removed
+        ----------------------------------------------
+
+        The `picture_gallery` feature of elements was removed and has been replaced by nestable elements.
+
+        The automatic updater that just ran updated your `config/alchemy/elements.yml`. A backup was made.
+        Nevertheless, you should have a look into it and double check the changes.
+
+        We created nested elements for each gallery picture we found in your database.
+
+        We also updated your element view partials so they have hints about how to render the child elements.
+
+        Cells replaced by fixed nestable elements
+        -----------------------------------------
+
+        The Cells feature has been replaced by fixed nestable elements.
+
+        The automatic updater that just ran updated your `config/alchemy/elements.yml`.
+        Nevertheless, you should have a look into it and double check the changes.
+
+        We defined new fixed elements for each cell former defined in `cells.yml`
+        and put its `elements` into the `nestable_elements` collection of the new elements definition.
+
+        We also updated your element view partials so they render the child elements.
+
+        Please review and fix markup, if necessary.
+
+        PLEASE DOUBLE CHECK YOUR ELEMENT PARTIALS AND ADJUST ACCORDINGLY!
+
+        As always `git diff` is your friend.
+
+        NOTE
+        todo notice, 'Alchemy v4.2 changes'
+      end
+    end
+  end
+end

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

@@ -0,0 +1,41 @@
+module Alchemy::Upgrader::Tasks
+  class CellsMigration
+    class Cell < ActiveRecord::Base
+      self.table_name = 'alchemy_cells'
+      belongs_to :page, class_name: 'Alchemy::Page'
+    end
+
+    def migrate_cells
+      if ActiveRecord::Base.connection.data_source_exists?('alchemy_cells')
+        cells = Cell.all
+
+        if cells.any?
+          cells.each do |cell|
+            migrate_cell!(cell)
+          end
+        else
+          puts "No cells found. Skip"
+        end
+      else
+        puts "Cells table does not exist. Skip"
+      end
+    end
+
+    private
+
+    def migrate_cell!(cell)
+      # bust element definitions insta cache
+      Alchemy::Element.instance_variable_set('@definitions', nil)
+      fixed_element = Alchemy::Element.find_or_initialize_by(fixed: true, name: cell.name, page: cell.page)
+      elements = Alchemy::Element.where(cell_id: cell.id)
+
+      if fixed_element.new_record?
+        fixed_element.nested_elements = elements
+        fixed_element.save!
+        puts "Created new fixed element '#{fixed_element.name}' for cell '#{cell.name}'."
+      else
+        puts "Element for cell '#{cell.name}' already present. Skip"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,146 @@
+require 'alchemy/upgrader'
+require 'rails/generators'
+
+module Alchemy::Upgrader::Tasks
+  class CellsUpgrader < Thor
+    include Thor::Actions
+
+    no_tasks do
+      def convert_cells
+        if File.exist?(page_layouts_config_file)
+          backup_config
+          convert_page_layouts_config
+        else
+          puts "\nNo page layouts config found. Skipping."
+        end
+        if File.exist?(cells_config_file)
+          convert_cell_config
+          delete_cells_config
+        else
+          puts "\nNo cells config found. Skipping."
+        end
+        update_cell_views
+        update_render_cell_calls
+        move_cell_views
+        generate_editor_partials
+        puts 'Done ✔'
+      end
+    end
+
+    private
+
+    def backup_config
+      print "-- Copy existing config file to `config/alchemy/page_layouts.yml.old` ... "
+
+      FileUtils.copy Rails.root.join('config', 'alchemy', 'page_layouts.yml'),
+                     Rails.root.join('config', 'alchemy', 'page_layouts.yml.old')
+
+      puts "done ✔\n"
+    end
+
+    def write_config(config)
+      print '-- Writing new `config/alchemy/page_layouts.yml` ... '
+
+      File.open(Rails.root.join('config', 'alchemy', 'page_layouts.yml'), "w") do |f|
+        f.write config.to_yaml.sub("---\n", "").gsub("\n-", "\n\n-")
+      end
+
+      puts "done ✔\n"
+    end
+
+    def convert_page_layouts_config
+      print '-- Moving `cells` from page layouts definition into autogenerated `elements` ... '
+      page_layouts = YAML.load_file(page_layouts_config_file)
+      page_layouts.select { |p| p['cells'].present? }.map do |page_layout|
+        elements = page_layout['elements'] || []
+        autogenerate_elements = page_layout['autogenerate'] || []
+        cell_elements = page_layout.delete('cells')
+        page_layout['elements'] = (elements + cell_elements).uniq
+        page_layout['autogenerate'] = (autogenerate_elements + cell_elements).uniq
+      end
+      puts "done ✔\n"
+      write_config(page_layouts)
+    end
+
+    def page_layouts_config_file
+      Rails.root.join('config', 'alchemy', 'page_layouts.yml')
+    end
+
+    def cells_config_file
+      Rails.root.join('config', 'alchemy', 'cells.yml')
+    end
+
+    def convert_cell_config
+      puts '-- Converting cells into unique fixed nestable elements.'
+
+      YAML.load_file(cells_config_file).each do |cell|
+        append_to_file Rails.root.join('config', 'alchemy', 'elements.yml') do
+          <<-CELL.strip_heredoc
+
+            - name: #{cell['name']}
+              fixed: true
+              unique: true
+              nestable_elements: [#{cell['elements'].join(', ')}]
+          CELL
+        end
+      end
+    end
+
+    def delete_cells_config
+      puts '-- Deleting cells config file.'
+      FileUtils.rm(cells_config_file)
+    end
+
+    def move_cell_views
+      if Dir.exist? cells_view_folder
+        puts "-- Move cell views into elements view folder"
+        Dir.glob("#{cells_view_folder}/*").each do |view|
+          filename = File.basename(view).gsub(/(_\w+)\.(\w*\.)?(erb|haml|slim)/, '\1_view.\2\3')
+          FileUtils.mv(view, "#{elements_view_folder}/#{filename}")
+          puts "   Moved #{File.basename(view)} into `app/views/alchemy/elements/` folder"
+        end
+        FileUtils.rm_rf(cells_view_folder)
+      else
+        puts "No cell views found. Skip"
+      end
+    end
+
+    def generate_editor_partials
+      puts "-- Generate editor partials"
+      Rails::Generators.invoke('alchemy:elements', ['--skip'])
+    end
+
+    def update_cell_views
+      if Dir.exist? cells_view_folder
+        puts "-- Update cell views"
+        Dir.glob("#{cells_view_folder}/*").each do |view|
+          gsub_file(view, /cell\.elements/, 'element.nested_elements.published')
+          gsub_file(view, /render_elements\(?from_cell:\scell\)?/, 'render element.nested_elements.published')
+          gsub_file(view, /cell/, 'element')
+        end
+      else
+        puts "No cell views found. Skip"
+      end
+    end
+
+    def update_render_cell_calls
+      puts "-- Update render_cell calls"
+      Dir.glob("#{alchemy_views_folder}/**/*").each do |view|
+        next if File.directory?(view)
+        gsub_file(view, /render_cell[\(\s]?([:'"]?[a-z_]+['"]?)\)?/, 'render_elements(only: \1, fixed: true)')
+      end
+    end
+
+    def elements_view_folder
+      Rails.root.join('app', 'views', 'alchemy', 'elements')
+    end
+
+    def cells_view_folder
+      Rails.root.join('app', 'views', 'alchemy', 'cells')
+    end
+
+    def alchemy_views_folder
+      Rails.root.join('app', 'views', 'alchemy')
+    end
+  end
+end

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

@@ -0,0 +1,65 @@
+module Alchemy
+  class Upgrader::Tasks::PictureGalleryMigration
+    def migrate_picture_galleries
+      if picture_gallery_elements.present?
+        picture_gallery_elements.each do |el|
+          migrate_element(el)
+        end
+      else
+        puts "No `picture_gallery` elements found. Skip"
+      end
+    end
+
+    private
+
+    def picture_gallery_elements
+      Element.distinct.joins(:contents).where("#{Content.table_name}.name LIKE 'essence_picture_%'")
+    end
+
+    def migrate_element(element)
+      gallery_contents = element.contents.where("#{Content.table_name}.name LIKE 'essence_picture_%'").order("#{Content.table_name}.position ASC")
+
+      if gallery_contents.any?
+        if element.nestable_elements.any? { |el| el != "#{element.name}_picture" }
+          parent = create_gallery_element(element)
+        else
+          parent = element
+        end
+        gallery_contents.each do |content|
+          create_element_for_content(content, parent)
+        end
+      else
+        puts "No gallery contents found for #{element.dom_id}. Skip"
+      end
+    end
+
+    def create_gallery_element(parent)
+      new_element = parent.nested_elements.create!(
+        name: "#{parent.name}_picture_gallery",
+        public: parent.public,
+        folded: parent.folded,
+        creator: parent.creator,
+        updater: parent.updater,
+        page: parent.page,
+        autogenerate_contents: false
+      )
+      puts "Created new `#{new_element.name}` for `#{parent.name}`"
+      new_element
+    end
+
+    def create_element_for_content(content, parent)
+      new_element = parent.nested_elements.create!(
+        name: "#{parent.name}_picture",
+        public: parent.public,
+        folded: parent.folded,
+        creator: parent.creator,
+        updater: parent.updater,
+        page: parent.page,
+        autogenerate_contents: false
+      )
+
+      content.update_columns(element_id: new_element.id, name: 'picture')
+      puts "Created new `#{new_element.name}` for `#{parent.name}`"
+    end
+  end
+end