alchemy_cms 3.2.1 → 3.3.0.rc1

data/lib/alchemy/touching.rb

@@ -1,6 +1,5 @@
 module Alchemy
   module Touching
-
     # Touches the timestamps and userstamps
     #
     def touch
@@ -18,8 +17,8 @@ module Alchemy
     # not on top to bottom ones like +Alchemy::Element+.
     #
     def touch_contents
-      return unless self.respond_to?(:contents)
-      self.contents.update_all(touchable_attributes)
+      return unless respond_to?(:contents)
+      contents.update_all(touchable_attributes)
     end
 
     # If the model has a +touchable_pages+ association,
@@ -28,14 +27,14 @@ module Alchemy
     # Used by +Alchemy::Element+
     #
     def touch_pages
-      return unless self.respond_to?(:touchable_pages)
-      self.touchable_pages.update_all(touchable_attributes)
+      return unless respond_to?(:touchable_pages)
+      touchable_pages.update_all(touchable_attributes)
     end
 
     # Returns the attributes hash for touching a model.
     #
     def touchable_attributes
-      {updated_at: Time.now, updater_id: Alchemy.user_class.try(:stamper)}
+      {updated_at: Time.current, updater_id: Alchemy.user_class.try(:stamper)}
     end
   end
 end

data/lib/alchemy/upgrader.rb

@@ -2,20 +2,19 @@ require 'alchemy/seeder'
 
 module Alchemy
   class Upgrader < Alchemy::Seeder
-
     Dir["#{File.dirname(__FILE__)}/upgrader/*.rb"].each { |f| require f }
 
+    extend Alchemy::Upgrader::ThreePointThree
     extend Alchemy::Upgrader::ThreePointTwo
     extend Alchemy::Upgrader::ThreePointOne
     extend Alchemy::Upgrader::ThreePointZero
 
     class << self
-
       # Runs ugrades
       #
       def run!
         upgrade_tasks.each do |task|
-          self.send(task)
+          send(task)
         end
         puts "\n"
         log "Upgrade done!"
@@ -62,7 +61,7 @@ module Alchemy
         desc "Copy configuration file."
         config_file = Rails.root.join('config/alchemy/config.yml')
         default_config = File.join(File.dirname(__FILE__), '../../config/alchemy/config.yml')
-        if !File.exists? config_file
+        if !File.exist? config_file
           log "No configuration file found. Creating it."
           FileUtils.cp default_config, Rails.root.join('config/alchemy/config.yml')
         elsif FileUtils.identical? default_config, config_file
@@ -74,7 +73,6 @@ module Alchemy
           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
   end
 end

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

@@ -0,0 +1,155 @@
+require 'thor'
+
+module Alchemy::Upgrader::Tasks
+  class AvailableContentsUpgrader < Thor
+    include Thor::Actions
+
+    AVAILABLE_CONTENTS_REGEXP = /^.*element.contents.(named|where).+\n.*render_essence.+\n(.*end.*\n)?/
+
+    no_tasks do
+      def convert_available_contents
+        config = read_config
+
+        elements_with_available_contents, new_elements = config.partition do |e|
+          e['available_contents']
+        end
+
+        if elements_with_available_contents.empty?
+          puts "No elements with `available_contents` found. Skipping."
+          return
+        end
+
+        convert_to_nestable_elements(elements_with_available_contents, new_elements)
+        backup_config
+        write_config(new_elements)
+        remove_new_content_link_from_editor_partials
+        replace_available_contents_rendering
+        remove_render_available_contents
+
+        puts "Generate new element partials for nestable elements"
+        system "rails g alchemy:elements --skip"
+      end
+    end
+
+    private
+
+    def read_config
+      print "1. Reading `config/alchemy/elements.yml` ... "
+
+      old_config_file = Rails.root.join('config', 'alchemy', 'elements.yml')
+      config = YAML.load_file(old_config_file)
+
+      puts "done.\n"
+
+      config
+    end
+
+    def convert_to_nestable_elements(elements_with_available_contents, new_elements)
+      print '2. Converting to `nestable_elements` ... '
+
+      elements_with_available_contents.inject(new_elements) do |ne, old_element|
+        ne << modify_old_element(old_element.dup)
+        build_new_elements(old_element).inject(ne) do |e, element_from_contents|
+          e << element_from_contents
+        end
+      end
+
+      puts 'done.'
+    end
+
+    def backup_config
+      print "3. Copy existing config file to `config/alchemy/elements.yml.old` ... "
+
+      FileUtils.copy Rails.root.join('config', 'alchemy', 'elements.yml'),
+                     Rails.root.join('config', 'alchemy', 'elements.yml.old')
+
+      puts "done.\n"
+    end
+
+    def write_config(config)
+      print '4. Writing new `config/alchemy/elements.yml` ... '
+
+      File.open(Rails.root.join('config', 'alchemy', 'elements.yml'), "w") do |f|
+        f.write config.to_yaml
+      end
+
+      puts "done.\n"
+    end
+
+    def remove_new_content_link_from_editor_partials
+      puts '5. Removing available contents link helpers from editor partials ... '
+
+      editor_partials = Dir.glob(Rails.root.join('app', 'views', 'alchemy', 'elements', '*_editor*'))
+      editor_partials.each do |partial|
+        gsub_file partial,
+          /^.*((delete|render_(create|new))_content|label_and_remove)_link.*$\n/, ''
+      end
+    end
+
+    def replace_available_contents_rendering
+      puts '6. Replace available contents rendering with nested elements in your element views:'
+
+      erb_snippet = <<-ERB
+    <%- element.nested_elements.available.each do |nested_element| -%>
+      <%= render_element(nested_element) %>
+    <%- end -%>
+ERB
+      erb_element_partials(:view).each do |view|
+        gsub_file view, AVAILABLE_CONTENTS_REGEXP, erb_snippet
+      end
+
+      haml_slim_snippet = <<-HAMLSLIM
+    - element.nested_elements.available.each do |nested_element|
+      = render_element(nested_element)
+HAMLSLIM
+      haml_slim_element_partials(:view).each do |view|
+        gsub_file view, AVAILABLE_CONTENTS_REGEXP, haml_slim_snippet
+      end
+    end
+
+    def remove_render_available_contents
+      puts '7. Remove available contents rendering from your element editors:'
+
+      erb_element_partials(:editor).each do |view|
+        gsub_file view, AVAILABLE_CONTENTS_REGEXP, ''
+      end
+
+      haml_slim_element_partials(:editor).each do |view|
+        gsub_file view, AVAILABLE_CONTENTS_REGEXP, ''
+      end
+    end
+
+    def modify_old_element(element)
+      nestable_elements = element['available_contents'].map do |content|
+        "#{element['name']}_#{content['name']}"
+      end
+      element.delete('available_contents')
+      element['nestable_elements'] = nestable_elements
+      element
+    end
+
+    def build_new_elements(element)
+      element['available_contents'].map do |content|
+        build_new_element(element, content)
+      end
+    end
+
+    def build_new_element(element, content)
+      # All nestable elements are deletable
+      content['settings'].delete('deletable') if content['settings']
+      content.delete('settings') if content['settings'] == {}
+      {
+        'name' => "#{element['name']}_#{content['name']}",
+        'contents' => [content]
+      }
+    end
+
+    def erb_element_partials(kind)
+      Dir.glob(Rails.root.join('app', 'views', 'alchemy', 'elements', "*_#{kind}.html.erb"))
+    end
+
+    def haml_slim_element_partials(kind)
+      Dir.glob(Rails.root.join('app', 'views', 'alchemy', 'elements', "*_#{kind}.html.{haml,slim}"))
+    end
+  end
+end

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

@@ -0,0 +1,71 @@
+module Alchemy::Upgrader::Tasks
+  class NestableElementsMigration
+    def migrate_existing_elements
+      elements_with_nestable_elements = Alchemy::Element.all.select do |e|
+        e.definition['nestable_elements']
+      end
+
+      if elements_with_nestable_elements.present?
+        elements_with_nestable_elements.each do |el|
+          migrate_element(el)
+        end
+      else
+        puts "No elements with `nestable_elements` found. Skip"
+      end
+    end
+
+    private
+
+    def migrate_element(el)
+      orphaned_contents = el.contents.where.not(name: element_content_names(el))
+
+      if orphaned_contents.present?
+        orphaned_contents.each do |content|
+          next unless addable_element_present_for?(content)
+          create_element_for_content(content)
+        end
+      else
+        puts "No orphaned contents found for #{el.dom_id}. Skip"
+      end
+    end
+
+    def element_content_names(el)
+      # names of contents directly defined on element
+      content_names = el.definition.fetch('contents', []).collect do |definition|
+        definition['name']
+      end
+
+      # names of contents defined on elements nestable elements
+      nestable_content_names = el.definition['nestable_elements'].collect { |name|
+        Alchemy::Element.definition_by_name(name).try(:content_definitions)
+      }.compact.collect { |c| c['name'] }.uniq
+
+      # we only want content names that are not defined on nestable elements, so we can move them
+      content_names - nestable_content_names
+    end
+
+    def create_element_for_content(content)
+      parent = content.element
+
+      new_element = Alchemy::Element.create(
+        name: "#{parent.name}_#{content.name}",
+        parent_element_id: parent.id,
+        public: parent.public,
+        folded: parent.folded,
+        creator: parent.creator,
+        updater: parent.updater,
+        page: parent.page,
+        create_contents_after_create: false
+      )
+
+      content.update_columns(element_id: new_element.id)
+      puts "Created new element `#{new_element.name}` for content `#{content.name}`"
+    end
+
+    def addable_element_present_for?(content)
+      Alchemy::Element.definitions.any? do |definition|
+        definition['name'] == "#{content.element.name}_#{content.name}"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+require 'thor'
+
+module Alchemy::Upgrader::Tasks
+  class ThreePointTwoTask < Thor
+    include Thor::Actions
+
+    no_tasks do
+      def patch_acts_as_taggable_on_migrations
+        sentinel = /def self.up/
+
+        aato_file = Dir.glob('db/migrate/*_acts_as_taggable_on_migration.*.rb').first
+        if aato_file
+          inject_into_file aato_file,
+            "\n    # inserted by Alchemy CMS upgrader\n    return if table_exists?(:tags)\n",
+            { after: sentinel, verbose: true }
+        end
+
+        aato_file = Dir.glob('db/migrate/*_add_missing_unique_indices.*.rb').first
+        if aato_file
+          inject_into_file aato_file,
+            "\n    # inserted by Alchemy CMS upgrader\n    return if index_exists?(:tags, :name)\n",
+            { after: sentinel, verbose: true }
+        end
+      end
+
+      def inject_seeder
+        append_file "./db/seeds.rb", "Alchemy::Seeder.seed!\n"
+      end
+    end
+  end
+end

data/lib/alchemy/upgrader/three_point_three.rb

@@ -0,0 +1,50 @@
+require_relative 'tasks/available_contents_upgrader'
+require_relative 'tasks/nestable_elements_migration'
+
+module Alchemy
+  module Upgrader::ThreePointThree
+    private
+
+    def convert_available_contents
+      desc 'Convert `available_contents` config to `nestable_elements`.'
+      Alchemy::Upgrader::Tasks::AvailableContentsUpgrader.new.convert_available_contents
+    end
+
+    def migrate_existing_elements
+      desc 'Migrate existing elements to `nestable_elements`.'
+      Alchemy::Upgrader::Tasks::NestableElementsMigration.new.migrate_existing_elements
+    end
+
+    def alchemy_3_3_todos
+      notice = <<-NOTE
+
+Element's "available_contents" feature removed
+----------------------------------------------
+
+The `available_contents` 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 defined elements for each content type former defined in `available_contents` and put its name
+into a new `nestable_elements` collection in the elements definition.
+
+We also updated your element view partials so they render the child elements.
+Please review and fix markup, if necessary.
+
+The code for the available contents buttons and links in the element editor partials were removed
+without replacement, because the nested elements editor partials render automatically.
+
+PLEASE DOUBLE CHECK YOUR ELEMENT PARTIALS AND ADJUST ACCORDINGLY!
+
+Uploader `allowed_filetypes` setting changed
+--------------------------------------------
+
+The name of the model is now namespaced. `alchemy/pictures` instead of just `pictures`.
+Please ensure, to copy the new setting from the `config.yml.defaults` file.
+
+NOTE
+      todo notice, 'Alchemy v3.3 changes'
+    end
+  end
+end

data/lib/alchemy/upgrader/three_point_two.rb

@@ -1,33 +1,4 @@
-require 'thor'
-
-class Alchemy::Upgrader::ThreePointTwoTask < Thor
-  include Thor::Actions
-
-  no_tasks do
-
-    def patch_acts_as_taggable_on_migrations
-      sentinel = /def self.up/
-
-      aato_file = Dir.glob('db/migrate/*_acts_as_taggable_on_migration.*.rb').first
-      if aato_file
-        inject_into_file aato_file,
-          "\n    # inserted by Alchemy CMS upgrader\n    return if table_exists?(:tags)\n",
-          { after: sentinel, verbose: true }
-      end
-
-      aato_file = Dir.glob('db/migrate/*_add_missing_unique_indices.*.rb').first
-      if aato_file
-        inject_into_file aato_file,
-          "\n    # inserted by Alchemy CMS upgrader\n    return if index_exists?(:tags, :name)\n",
-          { after: sentinel, verbose: true }
-      end
-    end
-
-    def inject_seeder
-      append_file "./db/seeds.rb", "Alchemy::Seeder.seed!\n"
-    end
-  end
-end
+require_relative 'tasks/three_point_two_task'
 
 module Alchemy
   module Upgrader::ThreePointTwo
@@ -36,14 +7,14 @@ module Alchemy
     def upgrade_acts_as_taggable_on_migrations
       desc 'Installs acts_as_taggable_on migrations.'
       if !`bundle exec rake railties:install:migrations FROM=acts_as_taggable_on_engine`.empty?
-        Alchemy::Upgrader::ThreePointTwoTask.new.patch_acts_as_taggable_on_migrations
+        Alchemy::Upgrader::Tasks::ThreePointTwoTask.new.patch_acts_as_taggable_on_migrations
       end
       `bundle exec rake db:migrate`
     end
 
     def inject_seeder
       desc 'Add Alchemy seeder to `db/seeds.rb` file.'
-      Alchemy::Upgrader::ThreePointTwoTask.new.inject_seeder
+      Alchemy::Upgrader::Tasks::ThreePointTwoTask.new.inject_seeder
     end
 
     def alchemy_3_2_todos

data/lib/alchemy/upgrader/three_point_zero.rb

@@ -88,6 +88,5 @@ for a detailed explanation.
 NOTE
       todo notice, 'Alchemy v3.0 changes'
     end
-
   end
 end

data/lib/alchemy/version.rb

@@ -1,5 +1,5 @@
 module Alchemy
-  VERSION = "3.2.1"
+  VERSION = "3.3.0.rc1"
 
   def self.version
     VERSION