alchemy_cms 4.2.0.rc1 → 4.2.0

data/lib/alchemy/shell.rb

@@ -49,14 +49,22 @@ module Alchemy
     def display_todos
       return if todos.empty?
 
-      log "\nTODOs:", :message
-      log "------\n", :message
+      log "\n+---------+", :message
+      log "| 📝 TODO |", :message
+      log "+---------+\n", :message
+      puts "\nWe did most of the work for you, but there are still some things left for you to do."
       todos.each_with_index do |todo, i|
         title = "\n#{i + 1}. #{todo[0]}"
         log title, :message
-        puts '-' * title.length
+        puts '=' * title.length
+        puts ""
         log todo[1], :message
       end
+      puts ""
+      puts "============================================================"
+      puts "= ✨ Please take a minute and read the notes from above ✨ ="
+      puts "============================================================"
+      puts ""
     end
 
     # Prints out the given log message with the color due to its type

data/lib/alchemy/test_support/factories.rb

@@ -1,3 +1,5 @@
-Dir[File.dirname(__FILE__) + '/factories/*.rb'].each do |file|
+# frozen_string_literal: true
+
+Dir["#{File.dirname(__FILE__)}/factories/*.rb"].each do |file|
   require file
 end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'factory_bot'
 
 FactoryBot.define do

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

@@ -1,4 +1,9 @@
+# frozen_string_literal: true
+
 require 'factory_bot'
+require 'alchemy/test_support/factories/element_factory'
+require 'alchemy/test_support/factories/essence_file_factory'
+require 'alchemy/test_support/factories/essence_picture_factory'
 require 'alchemy/test_support/factories/essence_text_factory'
 
 FactoryBot.define do

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'factory_bot'
 
 FactoryBot.define do

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

@@ -1,4 +1,7 @@
+# frozen_string_literal: true
+
 require 'factory_bot'
+require 'alchemy/test_support/factories/page_factory'
 
 FactoryBot.define do
   factory :alchemy_element, class: 'Alchemy::Element' do

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'factory_bot'
 require 'alchemy/test_support/factories/attachment_factory'
 

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'factory_bot'
 require 'alchemy/test_support/factories/picture_factory'
 

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'factory_bot'
 
 FactoryBot.define do

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'factory_bot'
 require 'alchemy/test_support/factories/site_factory'
 

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'factory_bot'
 require 'alchemy/test_support/factories/language_factory'
 

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'factory_bot'
 
 FactoryBot.define do

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'factory_bot'
 
 FactoryBot.define do

data/lib/alchemy/upgrader/four_point_one.rb

@@ -11,31 +11,31 @@ module Alchemy
       end
 
       def alchemy_4_1_todos
-        notice = <<-NOTE
+        notice = <<-NOTE.strip_heredoc
+          ℹ️  Changed tagging provider to Gutentag
+          ---------------------------------------
 
-        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.
 
-        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.
 
-        All your existing tags have been migrated to `Gutentag::Tag`s.
 
-        Removed Rails and non-English translations
-        ------------------------------------------
+          ⚠️  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.
+          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.
+          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.
+          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 changes'
+        todo notice, 'Alchemy v4.1 TODO'
       end
     end
   end

data/lib/alchemy/upgrader/four_point_two.rb

@@ -2,6 +2,7 @@ require_relative 'tasks/picture_gallery_upgrader'
 require_relative 'tasks/picture_gallery_migration'
 require_relative 'tasks/cells_upgrader'
 require_relative 'tasks/cells_migration'
+require_relative 'tasks/element_partial_name_variable_updater'
 
 module Alchemy
   class Upgrader::FourPointTwo < Upgrader
@@ -26,42 +27,58 @@ module Alchemy
         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
+        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!
 
-        Element's "picture_gallery" feature removed
-        ----------------------------------------------
 
-        The `picture_gallery` feature of elements was removed and has been replaced by nestable elements.
+          ⚠️️  Cells replaced by fixed 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.
+          The Cells feature has been replaced by fixed nestable elements.
 
-        We created nested elements for each gallery picture we found in your database.
+          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 also updated your element view partials so they have hints about how to render the child elements.
+          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.
 
-        Cells replaced by fixed nestable elements
-        -----------------------------------------
+          We also updated your element view partials so they render the child elements.
 
-        The Cells feature has been replaced by fixed nestable elements.
+          Please review and fix markup, if necessary.
 
-        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.
+          🚨 PLEASE DOUBLE CHECK YOUR ELEMENT PARTIALS AND ADJUST ACCORDINGLY!
 
-        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.
+          As always `git diff` is your friend.
 
-        We also updated your element view partials so they render the child elements.
 
-        Please review and fix markup, if necessary.
+          ℹ️  Element views use element partial name as local variable
+          -----------------------------------------------------------
 
-        PLEASE DOUBLE CHECK YOUR ELEMENT PARTIALS AND ADJUST ACCORDINGLY!
+          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.
 
-        As always `git diff` is your friend.
+          The former `element` variable is still present, though.
 
         NOTE
-        todo notice, 'Alchemy v4.2 changes'
+        todo notice, 'Alchemy v4.2 TODO'
       end
     end
   end

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

@@ -114,8 +114,9 @@ module Alchemy::Upgrader::Tasks
       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, /elements\.published/, 'elements.available')
+          gsub_file(view, /cell\.elements(.+)/, 'element.nested_elements\1')
+          gsub_file(view, /render_elements[\(\s]?:?from_cell:?\s?(=>)?\s?cell\)?/, 'render element.nested_elements.available')
           gsub_file(view, /cell/, 'element')
         end
       else

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

@@ -0,0 +1,28 @@
+# 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')
+          gsub_file(view, /cache\(?element([,\s\w:\-,=>'"\?\/]*)\)?/, "cache(#{variable_name}\\1)")
+          gsub_file(view, /render_essence_view_by_name\(?element([,\s\w:\-,=>'"\?\/]*)\)?/, "render_essence_view_by_name(#{variable_name}\\1)")
+          gsub_file(view, /element_view_for\(?element([,\s\w:\-,=>'"\?\/]*)\)?/, "element_view_for(#{variable_name}\\1)")
+          gsub_file(view, /element\.([\w\?]+)/, "#{variable_name}.\\1")
+        end
+      end
+    end
+
+    private
+
+    def elements_view_folder
+      Rails.root.join('app', 'views', 'alchemy', 'elements')
+    end
+  end
+end

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

@@ -91,39 +91,54 @@ module Alchemy::Upgrader::Tasks
     def find_gallery_pictures_rendering
       puts '5. Find element views that use gallery pictures:'
 
-      erb_snippet = <<-ERB
-    <%- element.nested_elements.available.each do |nested_element| -%>
-      <%= render_element(nested_element) %>
-    <%- end -%>
-ERB
+      erb_snippet = '   <%= render element.nested_elements.available %>'
       erb_views = erb_element_partials(:view).select do |view|
         next if File.read(view).match(GALLERY_PICTURES_ERB_REGEXP).nil?
+
         inject_into_file view,
-          "<%# TODO: Remove next block and render element.nested_elements.published instead %>\n",
+          "<%# TODO: Move the content of next block into its nestable element view and `render element.nested_elements.available` instead %>\n",
           before: GALLERY_PICTURES_ERB_REGEXP
         true
       end
 
-      haml_slim_snippet = <<-HAMLSLIM
-    - element.nested_elements.available.each do |nested_element|
-      = render_element(nested_element)
-HAMLSLIM
+      haml_slim_snippet = '   = element.nested_elements.available'
       haml_views = haml_slim_element_partials(:view).select do |view|
         next if File.read(view).match(GALLERY_PICTURES_HAML_REGEXP).nil?
+
         inject_into_file view,
-          "-# TODO: Remove next block and render element.nested_elements.published instead\n",
+          "-# TODO: Move the content of next block into its nestable element view and `render element.nested_elements.available` instead\n",
           before: GALLERY_PICTURES_HAML_REGEXP
         true
       end
 
-      if erb_views.any?
-        puts "- Found #{erb_views.length} ERB element views that render gallery pictures.\n"
-        puts "  Please replace `element.contents.gallery_pictures` with:"
-        puts erb_snippet
-      elsif haml_views.any?
-        puts "- Found #{haml_views.length} HAML/SLIM element views render gallery pictures.\n"
-        puts "  Please replace `element.contents.gallery_pictures` with:"
-        puts haml_slim_snippet
+      if erb_views.any? || haml_views.any?
+        puts ""
+        puts "⚠️  Found element views that render gallery pictures!\n"
+        puts ""
+        if erb_views.any?
+          puts "   Please replace `element.contents.gallery_pictures` with:"
+          puts ""
+          puts erb_snippet
+          puts ""
+          puts "   In these files:"
+          puts ""
+          erb_views.each_with_index do |view, index|
+            puts "   #{index + 1}. #{view}"
+          end
+          puts ""
+        end
+        if haml_views.any?
+          puts "   Please replace `element.contents.gallery_pictures` with:"
+          puts ""
+          puts haml_slim_snippet
+          puts ""
+          puts "   In these files:"
+          puts ""
+          haml_views.each_with_index do |view, index|
+            puts "   #{index + 1}. #{view}"
+          end
+          puts ""
+        end
       else
         puts "- No element views found that render gallery pictures.\n"
       end

data/lib/alchemy/version.rb

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

data/lib/tasks/alchemy/upgrade.rake

@@ -72,7 +72,8 @@ namespace :alchemy do
         '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:migrate_cells',
+        'alchemy:upgrade:4.2:update_element_partial_name_variable'
       ]
 
       desc 'Convert `picture_gallery` element definitions to `nestable_elements`.'
@@ -95,6 +96,11 @@ namespace :alchemy 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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: alchemy_cms
 version: !ruby/object:Gem::Version
-  version: 4.2.0.rc1
+  version: 4.2.0
 platform: ruby
 authors:
 - Thomas von Deyen
@@ -13,7 +13,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-29 00:00:00.000000000 Z
+date: 2019-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: active_model_serializers
@@ -61,16 +61,22 @@ dependencies:
   name: cancancan
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: coffee-rails
   requirement: !ruby/object:Gem::Requirement
@@ -78,6 +84,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -85,6 +94,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: dragonfly
   requirement: !ruby/object:Gem::Requirement
@@ -253,16 +265,22 @@ dependencies:
   name: ransack
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '1.8'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '1.8'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: request_store
   requirement: !ruby/object:Gem::Requirement
@@ -348,6 +366,7 @@ extra_rdoc_files: []
 files:
 - ".codeclimate.yml"
 - ".editorconfig"
+- ".github/FUNDING.yml"
 - ".github/ISSUE_TEMPLATE/Bug_report.md"
 - ".github/ISSUE_TEMPLATE/Feature_request.md"
 - ".gitignore"
@@ -355,7 +374,6 @@ files:
 - ".localeapp/config.rb"
 - ".rspec"
 - ".rubocop.yml"
-- ".teatro.yml"
 - ".travis.yml"
 - ".yardopts"
 - CHANGELOG.md
@@ -856,6 +874,7 @@ files:
 - lib/alchemy/upgrader/four_point_two.rb
 - lib/alchemy/upgrader/tasks/cells_migration.rb
 - lib/alchemy/upgrader/tasks/cells_upgrader.rb
+- lib/alchemy/upgrader/tasks/element_partial_name_variable_updater.rb
 - lib/alchemy/upgrader/tasks/harden_acts_as_taggable_on_migrations.rb
 - lib/alchemy/upgrader/tasks/picture_gallery_migration.rb
 - lib/alchemy/upgrader/tasks/picture_gallery_upgrader.rb
@@ -968,9 +987,8 @@ post_install_message: |+
 
   Need help? Try:
 
-  * http://stackoverflow.com/questions/tagged/alchemy-cms
-  * http://groups.google.com/group/alchemy-cms
-  * irc://irc.freenode.net#alchemy_cms
+  * https://stackoverflow.com/questions/tagged/alchemy-cms
+  * https://slackin.alchemy-cms.com
   -------------------------------------------------------------
 
 rdoc_options: []
@@ -983,9 +1001,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements:
 - ImageMagick (libmagick), v6.6 or greater.
 rubygems_version: 3.0.3