alchemy_cms 4.6.7 → 5.0.0.beta1

data/lib/alchemy/test_support/controller_requests.rb

@@ -1,93 +0,0 @@
-# *There is generally no need* to use this module. Instead, in
-# a functional/controller test against a Alchemy controller, just
-# use standard Rails functionality by including:
-#
-#   routes { Alchemy::Engine.routes }
-#
-# And then use standard Rails test `get`, `post` etc methods.
-#
-# Use this module to easily test Alchemy actions within Alchemy components
-# or inside your application to test routes for the mounted Alchemy engine.
-#
-# Inside your spec_helper.rb, include this module inside the RSpec.configure
-# block by doing this:
-#
-#   require 'alchemy/test_support/controller_requests'
-#   RSpec.configure do |c|
-#     c.include Alchemy::TestSupport::ControllerRequests, type: :controller
-#   end
-#
-# Then, in your controller tests, you can access alchemy routes like this:
-#
-#   require 'rails_helper'
-#
-#   describe Alchemy::Admin::PagesController do
-#     it "can see all the pages" do
-#       alchemy_get :index
-#     end
-#   end
-#
-# Use alchemy_get, alchemy_post, alchemy_put or alchemy_delete to make requests
-# to the Alchemy engine, and use regular get, post, put or delete to make
-# requests to your application.
-#
-# Note: Based on Spree::TestingSupport::ControllerRequests. Thanks <3
-#
-# @deprecated Use Rails build in test request methods instead
-#
-module Alchemy
-  module TestSupport
-    module ControllerRequests
-      extend ActiveSupport::Concern
-
-      # Executes a request simulating GET HTTP method
-      # @deprecated Use Rails test `get` helper instead
-      def alchemy_get(action, parameters = nil, session = nil, flash = nil)
-        process_alchemy_action(action, parameters, session, flash, "GET")
-      end
-      deprecate alchemy_get: :get, deprecator: Alchemy::Deprecation
-
-      # Executes a request simulating POST HTTP method
-      # @deprecated Use Rails test `post` helper instead
-      def alchemy_post(action, parameters = nil, session = nil, flash = nil)
-        process_alchemy_action(action, parameters, session, flash, "POST")
-      end
-      deprecate alchemy_post: :post, deprecator: Alchemy::Deprecation
-
-      # Executes a request simulating PUT HTTP method
-      # @deprecated Use Rails test `put` helper instead
-      def alchemy_put(action, parameters = nil, session = nil, flash = nil)
-        process_alchemy_action(action, parameters, session, flash, "PUT")
-      end
-      deprecate alchemy_put: :put, deprecator: Alchemy::Deprecation
-
-      # Executes a request simulating DELETE HTTP method
-      # @deprecated Use Rails test `delete` helper instead
-      def alchemy_delete(action, parameters = nil, session = nil, flash = nil)
-        process_alchemy_action(action, parameters, session, flash, "DELETE")
-      end
-      deprecate alchemy_delete: :delete, deprecator: Alchemy::Deprecation
-
-      # Executes a simulated XHR request
-      # @deprecated Use Rails test `xhr` helper instead
-      def alchemy_xhr(method, action, parameters = nil, session = nil, flash = nil)
-        process_alchemy_xhr_action(method, action, parameters, session, flash)
-      end
-      deprecate alchemy_xhr: :xhr, deprecator: Alchemy::Deprecation
-
-      private
-
-      def process_alchemy_action(action, parameters = nil, session = nil, flash = nil, method = "GET")
-        @routes = Alchemy::Engine.routes
-        parameters ||= {}
-        process(action, method, parameters, session, flash)
-      end
-
-      def process_alchemy_xhr_action(method, action, parameters = nil, session = nil, flash = nil)
-        @routes = Alchemy::Engine.routes
-        parameters ||= {}
-        xml_http_request(method, action, parameters, session, flash)
-      end
-    end
-  end
-end

data/lib/alchemy/upgrader/four_point_four.rb

@@ -1,52 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'tasks/element_views_updater'
-
-module Alchemy
-  class Upgrader::FourPointFour < Upgrader
-    class << self
-      def rename_element_views
-        desc "Remove '_view' suffix from element views."
-        Alchemy::Upgrader::Tasks::ElementViewsUpdater.new.rename_element_views
-      end
-
-      def update_local_variable
-        desc 'Update element views local variable to element name.'
-        Alchemy::Upgrader::Tasks::ElementViewsUpdater.new.update_local_variable
-      end
-
-      def alchemy_4_4_todos
-        notice = <<-NOTE.strip_heredoc
-
-          ℹ️  Element editor partials are deprecated
-          -----------------------------------------
-
-          The element editor partials are not needed anymore. They still work, but in order to
-          prepare the Alchemy 5 upgrade your should consider removing them now.
-
-          In order to update check if you have any messages in your editor partials and move them
-          to either a `warning` or `message` in your element definition.
-
-          Also check if you pass any values to EssenceSelects `select_values`. Move static values
-          to the `settings` of your content definition and either use EssencePage for referencing
-          pages or create a custom essence for other dynamic values.
-
-
-          ℹ️  The `_view` suffix of Element view partials is deprecated
-          -----------------------------------------------------------
-
-          The element view partials do not need the `_view` suffix anymore. Your files have been
-          renamed.
-
-          The local variable in your element views has been replaced by a variable named after the
-          element itself. A "article" element has a "_article.html.erb" partial and therefore
-          a `article` local variable now.
-
-          The former `element` variable is still present, though.
-
-        NOTE
-        todo notice, 'Alchemy v4.4 TODO'
-      end
-    end
-  end
-end

data/lib/alchemy/upgrader/four_point_one.rb

@@ -1,42 +0,0 @@
-require_relative 'tasks/harden_acts_as_taggable_on_migrations'
-
-module Alchemy
-  class Upgrader::FourPointOne < Upgrader
-    class << self
-      def harden_acts_as_taggable_on_migrations
-        desc 'Harden `acts_as_taggable_on_migrations`'
-        `bundle exec rake railties:install:migrations FROM=acts_as_taggable_on_engine`
-        Alchemy::Upgrader::Tasks::HardenActsAsTaggableOnMigrations.new.patch_migrations
-        `bundle exec rake db:migrate`
-      end
-
-      def alchemy_4_1_todos
-        notice = <<-NOTE.strip_heredoc
-          ℹ️  Changed tagging provider to Gutentag
-          ---------------------------------------
-
-          The automatic updater that just ran updated all existing `acts_as_taggable_on_migrations`,
-          so that they don't blow up if the `acts_as_taggable_on` gem is no longer available.
-
-          All your existing tags have been migrated to `Gutentag::Tag`s.
-
-
-          ⚠️  Removed Rails and non-English translations
-          ---------------------------------------------
-
-          Removed the Rails translations from our translation files and moved all non-english translation
-          files into the newly introduced `alchemy_i18n` gem.
-
-          If you need more translations than the default English one you can either put `alchemy_i18n`
-          in to your apps `Gemfile` or - recommended - copy only the translation files you need into your
-          apps `config/locales` folder.
-
-          For the Rails translations either put the `rails-i18n` gem into your apps Gemfile or - recommended -
-          copy only the translation files you need into your apps config/locales folder.
-
-        NOTE
-        todo notice, 'Alchemy v4.1 TODO'
-      end
-    end
-  end
-end

data/lib/alchemy/upgrader/four_point_six.rb

@@ -1,50 +0,0 @@
-# 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/upgrader/four_point_two.rb

@@ -1,86 +0,0 @@
-require_relative 'tasks/picture_gallery_upgrader'
-require_relative 'tasks/picture_gallery_migration'
-require_relative 'tasks/fixed_element_name_finder'
-require_relative 'tasks/cells_upgrader'
-require_relative 'tasks/cells_migration'
-require_relative 'tasks/element_partial_name_variable_updater'
-
-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 update_element_views_variable_name
-        desc 'Update element views to use element partial name variable.'
-        Alchemy::Upgrader::Tasks::ElementPartialNameVariableUpdater.new.update_element_views
-      end
-
-      def alchemy_4_2_todos
-        notice = <<-NOTE.strip_heredoc
-          ⚠️  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.
-
-          🚨 PLEASE LOOK INTO YOUR ELEMENT VIEW PARTIALS AND FOLLOW THE INSTRUCTIONS!
-
-
-          ⚠️️  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.
-
-
-          ℹ️  Element views use element partial name as local variable
-          -----------------------------------------------------------
-
-          The local `element` variable in your element views has been replaced by a variable named after the partial.
-          A "article" element has a "_article_view.html.erb" partial and therefore a `article_view` local variable now.
-
-          The former `element` variable is still present, though.
-
-        NOTE
-        todo notice, 'Alchemy v4.2 TODO'
-      end
-    end
-  end
-end

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

@@ -1,45 +0,0 @@
-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
-        @fixed_element_name_finder = FixedElementNameFinder.new
-
-        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: @fixed_element_name_finder.call(cell.name), page: cell.page)
-      elements = Alchemy::Element.where(cell_id: cell.id).order(position: :asc)
-
-      if fixed_element.new_record?
-        fixed_element.autogenerate_nested_elements = false
-        fixed_element.save!
-        Alchemy::Element.acts_as_list_no_update do
-          elements.update_all(parent_element_id: fixed_element.id)
-        end
-        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

@@ -1,166 +0,0 @@
-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.'
-      fixed_element_name_finder = FixedElementNameFinder.new
-
-      YAML.load_file(cells_config_file).each do |cell|
-        append_to_file Rails.root.join('config', 'alchemy', 'elements.yml') do
-          <<-CELL.strip_heredoc
-
-            - name: #{fixed_element_name_finder.call(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, /elements\.published/, 'elements')
-          gsub_file(view, /cell\.elements(.+)/, 'element.nested_elements\1')
-          gsub_file(view, /render_elements[\(\s]?:?from_cell:?\s?(=>)?\s?cell\)?/, 'render element.nested_elements')
-          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)
-        # <%= render_cell 'test' %>
-        # <%= render_cell('test') %>
-        # <%= render_cell("test", options: true) %>
-        content = File.binread(view)
-        content.gsub!(/render_cell([\s(]+)(['":])(\w+)([^\w])(.*?)/) do
-          element_name = CellNameMigrator.call($3)
-          "render_elements#{$1}only: #{$2}#{element_name}#{$4}, fixed: true#{$5}"
-        end
-        
-        # <%= render_elements from_cell: 'page_intro' %>
-        # <%= render_elements testing: 'blubb',     from_cell: :page_intro %>
-        # <%= render_elements from_cell: "page_intro", testing: 'blubb' %>
-        # <%= render_elements(from_cell: "page_intro", testing: 'blubb') %>
-        # <%= render_elements(testing: 'blubb', from_cell: "page_intro") %>
-        content.gsub!(/render_elements(.*?)from_cell[:\s=>]+([:'"])(\w+)(['"]?)(.*)/) do
-          element_name = CellNameMigrator.call($3)
-          "render_elements#{$1}only: #{$2}#{element_name}#{$4}, fixed: true#{$5}"
-        end
-        File.open(view, "wb") { |file| file.write(content) }
-      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/element_partial_name_variable_updater.rb

@@ -1,32 +0,0 @@
-# frozen_string_literal: true
-
-require 'alchemy/upgrader'
-
-module Alchemy::Upgrader::Tasks
-  class ElementPartialNameVariableUpdater < Thor
-    include Thor::Actions
-
-    no_tasks do
-      def update_element_views
-        puts "-- Update element views local variable to partial name"
-        Dir.glob("#{elements_view_folder}/*_view.*").each do |view|
-          variable_name = File.basename(view).gsub(/^_([\w-]*)\..*$/, '\1')
-          %w[
-            cache
-            render_essence_view_by_name
-            element_view_for
-          ].each do |method_name|
-            gsub_file(view, /#{method_name}([\s(]+)element([^\w])/, "#{method_name}\\1#{variable_name}\\2")
-          end
-          gsub_file(view, /([\s(%={]+)element([^\w:"'])/, "\\1#{variable_name}\\2")
-        end
-      end
-    end
-
-    private
-
-    def elements_view_folder
-      Rails.root.join('app', 'views', 'alchemy', 'elements')
-    end
-  end
-end

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

@@ -1,31 +0,0 @@
-module Alchemy::Upgrader::Tasks
-  class FixedElementNameFinder
-
-    def call(cell_name)
-      return cell_name if fixed_elements.include?(cell_name)
-      return "#{cell_name}_elements" if unfixed_elements.include?(cell_name)
-      cell_name
-    end
-
-    private
-
-    def fixed_elements
-      @_fixed_element_names ||= begin
-        definitions.select { |element| element['fixed'] }.map { |element| element['name'] }
-      end
-    end
-
-    def unfixed_elements
-      @_unfixed_elements ||= begin
-        definitions.reject { |element| element['fixed'] }.map { |element| element['name'] }
-      end
-    end
-
-    def definitions
-      @_definitions ||= begin
-        elements_file_path = Rails.root.join('config', 'alchemy', 'elements.yml')
-        YAML.load_file(elements_file_path)
-      end
-    end
-  end
-end

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

@@ -1,27 +0,0 @@
-require 'thor'
-
-module Alchemy::Upgrader::Tasks
-  class HardenActsAsTaggableOnMigrations < Thor
-    include Thor::Actions
-
-    no_tasks do
-      def patch_migrations
-        sentinel = /add_column.*/
-        aato_file = Dir.glob('db/migrate/*_add_taggings_counter_cache_to_tags.*.rb').first
-        if aato_file
-          inject_into_file aato_file,
-            "\n\n    # inserted by Alchemy CMS upgrader\n    return unless defined?(ActsAsTaggableOn)",
-            { after: sentinel, verbose: true }
-        end
-
-        sentinel = /def up/
-        aato_file = Dir.glob('db/migrate/*_change_collation_for_tag_names.*.rb').first
-        if aato_file
-          inject_into_file aato_file,
-            "\n    # inserted by Alchemy CMS upgrader\n    return unless defined?(ActsAsTaggableOn)\n",
-            { after: sentinel, verbose: true }
-        end
-      end
-    end
-  end
-end