alchemy_cms 3.4.2 → 3.5.0.rc1

data/lib/alchemy/test_support/essence_shared_examples.rb

@@ -6,6 +6,8 @@ shared_examples_for "an essence" do
   let(:content_definition) { {'name' => 'foo'} }
 
   it "touches the content after update" do
+    element = create(:alchemy_element)
+    content = create(:alchemy_content, element: element)
     essence.save
     content.update(essence: essence, essence_type: essence.class.name)
     date = content.updated_at

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

@@ -2,7 +2,7 @@ require 'factory_girl'
 
 FactoryGirl.define do
   factory :alchemy_attachment, class: 'Alchemy::Attachment' do
-    file File.new(File.expand_path('../../../../../spec/fixtures/image.png', __FILE__))
+    file File.new(Alchemy::Engine.root.join('lib', 'alchemy', 'test_support', 'fixtures', 'image.png'))
     name 'image'
     file_name 'image.png'
   end

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

@@ -6,5 +6,6 @@ FactoryGirl.define do
     name "text"
     essence_type "Alchemy::EssenceText"
     association :essence, factory: :alchemy_essence_text
+    association :element, factory: :alchemy_element
   end
 end

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

@@ -4,6 +4,7 @@ FactoryGirl.define do
   factory :alchemy_element, class: 'Alchemy::Element' do
     name 'article'
     create_contents_after_create false
+    association :page, factory: :alchemy_page
 
     trait :unique do
       unique true

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

@@ -2,7 +2,7 @@ require 'factory_girl'
 
 FactoryGirl.define do
   factory :alchemy_picture, class: 'Alchemy::Picture' do
-    image_file File.new(File.expand_path('../../../../../spec/fixtures/image.png', __FILE__))
+    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

data/lib/alchemy/tinymce.rb

@@ -32,12 +32,8 @@ module Alchemy
         @@init
       end
 
-      def custom_config_contents(page = nil)
-        if page
-          content_definitions_from_elements(page.element_definitions)
-        else
-          content_definitions_from_elements(Element.definitions)
-        end
+      def custom_config_contents(page)
+        content_definitions_from_elements(page.descendent_element_definitions)
       end
 
       private

data/lib/alchemy/upgrader.rb

@@ -1,63 +1,12 @@
-require 'alchemy/seeder'
+require 'alchemy/shell'
 
 module Alchemy
-  class Upgrader < Alchemy::Seeder
-    Dir["#{File.dirname(__FILE__)}/upgrader/*.rb"].each { |f| require f }
+  class Upgrader
+    extend Alchemy::Shell
 
-    extend Alchemy::Upgrader::ThreePointFour
-    extend Alchemy::Upgrader::ThreePointThree
-    extend Alchemy::Upgrader::ThreePointTwo
-    extend Alchemy::Upgrader::ThreePointOne
-    extend Alchemy::Upgrader::ThreePointZero
+    Dir["#{File.dirname(__FILE__)}/upgrader/*.rb"].each { |f| require f }
 
     class << self
-      # Runs ugrades
-      #
-      def run!
-        upgrade_tasks.each do |task|
-          send(task)
-        end
-        puts "\n"
-        log "Upgrade done!"
-        if todos.any?
-          display_todos
-          log "\nThere are some follow ups to do", :message
-          log '-------------------------------', :message
-          log "\nPlease follow the TODOs above.", :message
-        else
-          log "\nThat's it.", :message
-        end
-      end
-
-      # Tasks that should run.
-      #
-      # Set UPGRADE env variable to only run a specific task.
-      #
-      # Run +rake alchemy:upgrade:list+ for all available tasks
-      #
-      def upgrade_tasks
-        if ENV['UPGRADE'].present?
-          ENV['UPGRADE'].split(',')
-        else
-          all_upgrade_tasks
-        end
-      end
-
-      # All available upgrade tasks
-      #
-      def all_upgrade_tasks
-        private_methods - Object.private_methods - superclass.private_methods
-      end
-
-      private
-
-      # Setup task
-      def setup
-        Rake::Task['alchemy:install:migrations'].invoke
-        Rake::Task['db:migrate'].invoke
-        Seeder.seed!
-      end
-
       def copy_new_config_file
         desc "Copy configuration file."
         config_file = Rails.root.join('config/alchemy/config.yml')

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

@@ -0,0 +1,14 @@
+module Alchemy::Upgrader::Tasks
+  class InstallDragonflyConfig < Thor
+    include Thor::Actions
+
+    source_root File.expand_path('../../../rails/generators/alchemy/install/templates',
+      File.dirname(__FILE__))
+
+    no_tasks do
+      def install
+        template "dragonfly.rb.tt", "config/initializers/dragonfly.rb"
+      end
+    end
+  end
+end

data/lib/alchemy/upgrader/three_point_five.rb

@@ -0,0 +1,32 @@
+require_relative 'tasks/install_dragonfly_config'
+
+module Alchemy
+  class Upgrader::ThreePointFive < Upgrader
+    class << self
+      def install_dragonfly_config
+        desc 'Install dragonfly config into `config/initializers`'
+        Alchemy::Upgrader::Tasks::InstallDragonflyConfig.new.install
+      end
+
+      def alchemy_3_5_todos
+        notice = <<-NOTE
+
+        Picture rendering switched to Dragonfly middleware
+        --------------------------------------------------
+
+        Alchemy now uses the Dragonfly middleware to render the pictures and
+        REMOVED THE LOCAL PICTURE CACHING!
+
+        This has effect on your production setup and NEEDS FURTHER ACTION in order to
+        provide a caching option that works for your setup.
+
+        Please follow the guidelines about picture caching on the Dragonfly homepage:
+
+        http://markevans.github.io/dragonfly/cache/
+
+        NOTE
+        todo notice, 'Alchemy v3.5 changes'
+      end
+    end
+  end
+end

data/lib/alchemy/upgrader/three_point_four.rb

@@ -1,16 +1,10 @@
 require_relative 'tasks/install_asset_manifests'
 
 module Alchemy
-  module Upgrader::ThreePointFour
-    private
-
-    def install_asset_manifests
+  class Upgrader::ThreePointFour < Upgrader
+    def self.install_asset_manifests
       desc 'Install asset manifests into `vendor/assets`'
       Alchemy::Upgrader::Tasks::InstallAssetManifests.new.install
     end
-
-    def alchemy_3_4_todos
-      todo "Nothing todo for Alchemy 3.4 |o/", 'Alchemy v3.4 changes'
-    end
   end
 end

data/lib/alchemy/upgrader/three_point_one.rb

@@ -1,54 +1,54 @@
 module Alchemy
-  module Upgrader::ThreePointOne
-    private
+  class Upgrader::ThreePointOne < Upgrader
+    class << self
+      def alchemy_3_1_todos
+        notice = <<-NOTE
 
-    def alchemy_3_1_todos
-      notice = <<-NOTE
+  JSON API moved into '/api' namespace
+  ------------------------------------
 
-JSON API moved into '/api' namespace
-------------------------------------
+  The JSON API now lives under /api and not as additional format to default controllers.
+  Also the serialization changed into more useful payload.
 
-The JSON API now lives under /api and not as additional format to default controllers.
-Also the serialization changed into more useful payload.
+  Please upgrade your API calls to use the new /api namespace.
 
-Please upgrade your API calls to use the new /api namespace.
 
+  TinyMCE default paste behavior changed
+  --------------------------------------
 
-TinyMCE default paste behavior changed
---------------------------------------
+  Text is now always pasted in as plain text. To change this, the user has to
+  disable it with the toolbar button, as they had to before to enable it.
 
-Text is now always pasted in as plain text. To change this, the user has to
-disable it with the toolbar button, as they had to before to enable it.
+  If you have a custom TinyMCE configuration you have to enable this by adding
 
-If you have a custom TinyMCE configuration you have to enable this by adding
+    paste_as_text: true
 
-  paste_as_text: true
+  into you custom TinyMCE configuration.
 
-into you custom TinyMCE configuration.
 
+  TinyMCE toolbar config has changed
+  ----------------------------------
 
-TinyMCE toolbar config has changed
-----------------------------------
+  The 'toolbar' configuration now takes an array of toolbar rows, instead of
+  using 'toolbarN' syntax. Please update your TinyMCE configuration.
 
-The 'toolbar' configuration now takes an array of toolbar rows, instead of
-using 'toolbarN' syntax. Please update your TinyMCE configuration.
+  Visit http://www.tinymce.com/wiki.php/Configuration:toolbar for more information.
 
-Visit http://www.tinymce.com/wiki.php/Configuration:toolbar for more information.
 
+  ApplicationController patch removed
+  -----------------------------------
 
-ApplicationController patch removed
------------------------------------
+  If you have controllers that loads Alchemy content or uses Alchemy helpers in
+  the views (i.e. `render_navigation` or `render_elements`) you should
 
-If you have controllers that loads Alchemy content or uses Alchemy helpers in
-the views (i.e. `render_navigation` or `render_elements`) you should
+    include Alchemy::ControllerActions
 
-  include Alchemy::ControllerActions
+  in these controllers.
 
-in these controllers.
 
-
-NOTE
-      todo notice, 'Alchemy v3.1 changes'
+  NOTE
+        todo notice, 'Alchemy v3.1 changes'
+      end
     end
   end
 end

data/lib/alchemy/upgrader/three_point_three.rb

@@ -2,49 +2,49 @@ require_relative 'tasks/available_contents_upgrader'
 require_relative 'tasks/nestable_elements_migration'
 
 module Alchemy
-  module Upgrader::ThreePointThree
-    private
+  class Upgrader::ThreePointThree < Upgrader
+    class << self
+      def convert_available_contents
+        desc 'Convert `available_contents` config to `nestable_elements`.'
+        Alchemy::Upgrader::Tasks::AvailableContentsUpgrader.new.convert_available_contents
+      end
 
-    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 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
+      def alchemy_3_3_todos
+        notice = <<-NOTE
 
-Element's "available_contents" feature removed
-----------------------------------------------
+        Element's "available_contents" feature removed
+        ----------------------------------------------
 
-The `available_contents` feature of elements was removed and has been replaced by nestable elements.
+        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.
+        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 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.
+        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.
+        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!
+        PLEASE DOUBLE CHECK YOUR ELEMENT PARTIALS AND ADJUST ACCORDINGLY!
 
-Uploader `allowed_filetypes` setting changed
---------------------------------------------
+        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.
+        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'
+        NOTE
+        todo notice, 'Alchemy v3.3 changes'
+      end
     end
   end
 end

data/lib/alchemy/upgrader/three_point_two.rb

@@ -1,40 +1,40 @@
 require_relative 'tasks/three_point_two_task'
 
 module Alchemy
-  module Upgrader::ThreePointTwo
-    private
-
-    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::Tasks::ThreePointTwoTask.new.patch_acts_as_taggable_on_migrations
+  class Upgrader::ThreePointTwo < Upgrader
+    class << self
+      def upgrade_acts_as_taggable_on_migrations
+        desc 'Install and patch acts_as_taggable_on migrations.'
+        if !`bundle exec rake railties:install:migrations FROM=acts_as_taggable_on_engine`.empty?
+          Alchemy::Upgrader::Tasks::ThreePointTwoTask.new.patch_acts_as_taggable_on_migrations
+        end
+        `bundle exec rake db:migrate`
       end
-      `bundle exec rake db:migrate`
-    end
 
-    def inject_seeder
-      desc 'Add Alchemy seeder to `db/seeds.rb` file.'
-      Alchemy::Upgrader::Tasks::ThreePointTwoTask.new.inject_seeder
-    end
+      def inject_seeder
+        desc 'Add Alchemy seeder to `db/seeds.rb` file.'
+        Alchemy::Upgrader::Tasks::ThreePointTwoTask.new.inject_seeder
+      end
 
-    def alchemy_3_2_todos
-      notice = <<-NOTE
+      def alchemy_3_2_todos
+        notice = <<-NOTE
 
-Capistrano 2 deploy script removed
-----------------------------------
+  Capistrano 2 deploy script removed
+  ----------------------------------
 
-The Capistrano 2 based deploy script has been removed and replaced by an Capistrano 3 extension.
+  The Capistrano 2 based deploy script has been removed and replaced by an Capistrano 3 extension.
 
-Please update your Gemfile:
+  Please update your Gemfile:
 
-group :development do
-  gem 'capistrano-alchemy', github: 'AlchemyCMS/capistrano-alchemy', branch: 'master', require: false
-end
+  group :development do
+    gem 'capistrano-alchemy', github: 'AlchemyCMS/capistrano-alchemy', branch: 'master', require: false
+  end
 
-For more information please visit https://github.com/AlchemyCMS/capistrano-alchemy.
+  For more information please visit https://github.com/AlchemyCMS/capistrano-alchemy.
 
-NOTE
-      todo notice, 'Alchemy v3.2 changes'
+  NOTE
+        todo notice, 'Alchemy v3.2 changes'
+      end
     end
   end
 end

data/lib/alchemy/upgrader/three_point_zero.rb

@@ -1,92 +1,92 @@
 module Alchemy
-  module Upgrader::ThreePointZero
-    private
-
-    def rename_registered_role_ro_member
-      if Alchemy.user_class.column_names.include?('alchemy_roles')
-        desc 'Rename the `registered` user role to `member`'
-        registered_users = Alchemy.user_class.where("alchemy_roles LIKE '%registered%'")
-        if registered_users.any?
-          registered_users.each do |user|
-            roles = user.read_attribute(:alchemy_roles).sub(/registered/, 'member')
-            user.update_column(:alchemy_roles, roles)
-            log "Renamed #{user.inspect} role to `member`"
+  class Upgrader::ThreePointZero < Upgrader
+    class << self
+      def rename_registered_role_ro_member
+        if Alchemy.user_class.column_names.include?('alchemy_roles')
+          desc 'Rename the `registered` user role to `member`'
+          registered_users = Alchemy.user_class.where("alchemy_roles LIKE '%registered%'")
+          if registered_users.any?
+            registered_users.each do |user|
+              roles = user.read_attribute(:alchemy_roles).sub(/registered/, 'member')
+              user.update_column(:alchemy_roles, roles)
+              log "Renamed #{user.inspect} role to `member`"
+            end
+          else
+            log 'No users with `registered` role found.', :skip
           end
         else
-          log 'No users with `registered` role found.', :skip
+          log 'No users with `alchemy_roles` database column found.', :skip
         end
-      else
-        log 'No users with `alchemy_roles` database column found.', :skip
       end
-    end
 
-    def publish_unpublished_public_pages
-      desc 'Sets `published_at` of public pages without a `published_at` date set to their `updated_at` value'
-      public_pages = Alchemy::Page.published.where('published_at IS NULL')
-      if public_pages.any?
-        public_pages.each do |page|
-          page.update_column(:published_at, page.updated_at)
-          log "Sets `published_at` of #{page.name} to #{page.updated_at}"
+      def publish_unpublished_public_pages
+        desc 'Sets `published_at` of public pages without a `published_at` date set to their `updated_at` value'
+        public_pages = Alchemy::Page.published.where('published_at IS NULL')
+        if public_pages.any?
+          public_pages.each do |page|
+            page.update_column(:published_at, page.updated_at)
+            log "Sets `published_at` of #{page.name} to #{page.updated_at}"
+          end
+        else
+          log 'No unpublished public pages found.', :skip
         end
-      else
-        log 'No unpublished public pages found.', :skip
       end
-    end
 
-    def alchemy_3_0_todos
-      notice = <<-NOTE
+      def alchemy_3_0_todos
+        notice = <<-NOTE
 
-Alchemy User Class Removed
---------------------------
+  Alchemy User Class Removed
+  --------------------------
 
-We removed the users model from Alchemy core!
+  We removed the users model from Alchemy core!
 
-You have to provide your own user model or
-add the `alchemy-devise` gem to your Gemfile.
+  You have to provide your own user model or
+  add the `alchemy-devise` gem to your Gemfile.
 
-If you want to use the default user class from Alchemy:
+  If you want to use the default user class from Alchemy:
 
-  # Gemfile
-  gem 'alchemy-devise'
+    # Gemfile
+    gem 'alchemy-devise'
 
-  $ bin/rake alchemy_devise:install:migrations db:migrate
+    $ bin/rake alchemy_devise:install:migrations db:migrate
 
-In order to add your own user class to Alchemy, please
-make shure it meets the API:
+  In order to add your own user class to Alchemy, please
+  make shure it meets the API:
 
-https://github.com/magiclabs/alchemy_cms/blob/master/lib/alchemy/auth_accessors.rb
+  https://github.com/magiclabs/alchemy_cms/blob/master/lib/alchemy/auth_accessors.rb
 
 
-TinyMCE 4 Upgrade
------------------
+  TinyMCE 4 Upgrade
+  -----------------
 
-The TinyMCE configuration syntax has changed!
+  The TinyMCE configuration syntax has changed!
 
-If you have custom TinyMCE confugurations, like a customized toolbar
-then you have to upgrade the syntax to a TinyMCE 4 compatible one.
+  If you have custom TinyMCE confugurations, like a customized toolbar
+  then you have to upgrade the syntax to a TinyMCE 4 compatible one.
 
-Please have a look in the default TinyMCE configuration from Alchemy and
-also read the official TinyMCE documentation in how to upgrade.
+  Please have a look in the default TinyMCE configuration from Alchemy and
+  also read the official TinyMCE documentation in how to upgrade.
 
-Alchemy default TinyMCE config: https://github.com/magiclabs/alchemy_cms/blob/master/lib/alchemy/tinymce.rb#L5-L19
-Offical TinyMCE documentation: http://www.tinymce.com/wiki.php/Configuration
+  Alchemy default TinyMCE config: https://github.com/magiclabs/alchemy_cms/blob/master/lib/alchemy/tinymce.rb#L5-L19
+  Offical TinyMCE documentation: http://www.tinymce.com/wiki.php/Configuration
 
 
-Essence Validation Syntax changed
----------------------------------
+  Essence Validation Syntax changed
+  ---------------------------------
 
-The API of the format validations for essences has changed.
-You can now define individual format matchers in the config.yml.
+  The API of the format validations for essences has changed.
+  You can now define individual format matchers in the config.yml.
 
-* `format_as` and `format_with` options has been removed and renamed to simply `format`
+  * `format_as` and `format_with` options has been removed and renamed to simply `format`
 
-Pleae have a look at this commit:
-https://github.com/AlchemyCMS/alchemy_cms/commit/44866dbebaed00ffa3b77201f93a04616001b955
+  Pleae have a look at this commit:
+  https://github.com/AlchemyCMS/alchemy_cms/commit/44866dbebaed00ffa3b77201f93a04616001b955
 
-for a detailed explanation.
+  for a detailed explanation.
 
-NOTE
-      todo notice, 'Alchemy v3.0 changes'
+  NOTE
+        todo notice, 'Alchemy v3.0 changes'
+      end
     end
   end
 end