lc_alchemy_cms 3.2.0

data/lib/alchemy/test_support/integration_helpers.rb

@@ -0,0 +1,33 @@
+module Alchemy
+  module TestSupport
+
+    # Helpers for integration specs
+    #
+    # This file is included in spec_helper.rb
+    #
+    module IntegrationHelpers
+
+      # Used to stub the current_alchemy_user
+      #
+      # Pass either a user object or a symbol in the format of ':as_admin'.
+      # The browser language is set to english ('en')
+      #
+      def authorize_user(user_or_role = nil)
+        if user_or_role.is_a?(Alchemy.user_class)
+          user = user_or_role
+        else
+          user = build(:alchemy_dummy_user, user_or_role)
+        end
+        set_phantomjs_browser_language("en")
+        allow_any_instance_of(ApplicationController).to receive(:current_user).and_return(user)
+      end
+
+      def set_phantomjs_browser_language(lang = nil)
+        if Capybara.current_driver == :poltergeist
+          page.driver.headers = {"Accept-Language" => lang}
+        end
+      end
+    end
+
+  end
+end

data/lib/alchemy/tinymce.rb

@@ -0,0 +1,68 @@
+module Alchemy
+  module Tinymce
+    mattr_accessor :languages, :plugins
+
+    @@plugins = %w(alchemy_link anchor autoresize charmap code directionality fullscreen hr link paste tabfocus table)
+    @@languages = ['en', 'de']
+    @@init = {
+      skin: 'alchemy',
+      width: '100%',
+      resize: true,
+      autoresize_min_height: '105',
+      autoresize_max_height: '480',
+      menubar: false,
+      statusbar: true,
+      toolbar: [
+        'bold italic underline | strikethrough subscript superscript | numlist bullist indent outdent | removeformat | fullscreen',
+        'pastetext charmap hr | undo redo | alchemy_link unlink anchor | code'
+      ],
+      fix_list_elements: true,
+      convert_urls: false,
+      entity_encoding: 'raw',
+      paste_as_text: true,
+      element_format: 'html'
+    }
+
+    def self.init=(settings)
+      if contains_old_tinymce_toolbar_config?('tinymce' => settings.stringify_keys)
+        warn_about_deprecation!
+      end
+      @@init.merge!(settings)
+    end
+
+    def self.init
+      @@init
+    end
+
+    def self.custom_config_contents(page = nil)
+      if page
+        definitions = content_definitions_from_elements(page.element_definitions)
+      else
+        definitions = content_definitions_from_elements(Element.definitions)
+      end
+      if definitions.any? { |d| contains_old_tinymce_toolbar_config?(d['settings']) }
+        warn_about_deprecation!
+      end
+      definitions
+    end
+
+    private
+
+    def self.content_definitions_from_elements(definitions)
+      definitions.collect do |el|
+        next if el['contents'].blank?
+        contents = el['contents'].select { |c| c['settings'] && c['settings']['tinymce'].present? }
+        next if contents.blank?
+        contents.map { |c| c.merge('element' => el['name']) }
+      end.flatten.compact
+    end
+
+    def self.contains_old_tinymce_toolbar_config?(settings)
+      settings['tinymce'] && settings['tinymce'].keys.any? { |k| k.match(/toolbar[0-9]/) }
+    end
+
+    def self.warn_about_deprecation!
+      ActiveSupport::Deprecation.warn("You use old TinyMCE 4.0 based toolbar config! Please consider to upgrade it to 4.1 compatible syntax. I.e. don't use 'toolbarN', use 'toolbar' with array instead. Visit http://www.tinymce.com/wiki.php/Configuration:toolbar for more information.")
+    end
+  end
+end

data/lib/alchemy/touching.rb

@@ -0,0 +1,41 @@
+module Alchemy
+  module Touching
+
+    # Touches the timestamps and userstamps
+    #
+    def touch
+      # Using update here, because we want the touch call to bubble up to the page.
+      update(touchable_attributes)
+    end
+
+    private
+
+    # If the model has a +contents+ association,
+    # it updates all their timestamps.
+    #
+    # CAUTION: Only use on bottom to top releations,
+    # e.g. +Alchemy::Picture+ or +Alchemy::Attachment+
+    # not on top to bottom ones like +Alchemy::Element+.
+    #
+    def touch_contents
+      return unless self.respond_to?(:contents)
+      self.contents.update_all(touchable_attributes)
+    end
+
+    # If the model has a +touchable_pages+ association,
+    # it updates all their timestamps.
+    #
+    # Used by +Alchemy::Element+
+    #
+    def touch_pages
+      return unless self.respond_to?(:touchable_pages)
+      self.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)}
+    end
+  end
+end

data/lib/alchemy/upgrader.rb

@@ -0,0 +1,80 @@
+require 'alchemy/seeder'
+
+module Alchemy
+  class Upgrader < Alchemy::Seeder
+
+    Dir["#{File.dirname(__FILE__)}/upgrader/*.rb"].each { |f| require f }
+
+    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)
+        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')
+        default_config = File.join(File.dirname(__FILE__), '../../config/alchemy/config.yml')
+        if !File.exists? 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
+          log "Configuration file already present.", :skip
+        else
+          log "Custom configuration file found."
+          FileUtils.cp default_config, Rails.root.join('config/alchemy/config.yml.defaults')
+          log "Copied new default configuration file."
+          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/three_point_one.rb

@@ -0,0 +1,54 @@
+module Alchemy
+  module Upgrader::ThreePointOne
+    private
+
+    def alchemy_3_1_todos
+      notice = <<-NOTE
+
+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.
+
+Please upgrade your API calls to use the new /api namespace.
+
+
+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.
+
+If you have a custom TinyMCE configuration you have to enable this by adding
+
+  paste_as_text: true
+
+into you custom TinyMCE configuration.
+
+
+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.
+
+Visit http://www.tinymce.com/wiki.php/Configuration:toolbar for more information.
+
+
+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
+
+  include Alchemy::ControllerActions
+
+in these controllers.
+
+
+NOTE
+      todo notice, 'Alchemy v3.1 changes'
+    end
+  end
+end

data/lib/alchemy/upgrader/three_point_two.rb

@@ -0,0 +1,69 @@
+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
+
+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::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
+    end
+
+    def alchemy_3_2_todos
+      notice = <<-NOTE
+
+Capistrano 2 deploy script removed
+----------------------------------
+
+The Capistrano 2 based deploy script has been removed and replaced by an Capistrano 3 extension.
+
+Please update your Gemfile:
+
+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.
+
+NOTE
+      todo notice, 'Alchemy v3.2 changes'
+    end
+  end
+end

data/lib/alchemy/upgrader/three_point_zero.rb

@@ -0,0 +1,93 @@
+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`"
+          end
+        else
+          log 'No users with `registered` role 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}"
+        end
+      else
+        log 'No unpublished public pages found.', :skip
+      end
+    end
+
+    def alchemy_3_0_todos
+      notice = <<-NOTE
+
+Alchemy User Class Removed
+--------------------------
+
+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.
+
+If you want to use the default user class from Alchemy:
+
+  # Gemfile
+  gem 'alchemy-devise'
+
+  $ 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:
+
+https://github.com/magiclabs/alchemy_cms/blob/master/lib/alchemy/auth_accessors.rb
+
+
+TinyMCE 4 Upgrade
+-----------------
+
+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.
+
+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
+
+
+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.
+
+* `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
+
+for a detailed explanation.
+
+NOTE
+      todo notice, 'Alchemy v3.0 changes'
+    end
+
+  end
+end

data/lib/alchemy/userstamp.rb

@@ -0,0 +1,10 @@
+# Adds the model stamper ability to the provided user class
+#
+# It only adds it, if the user model is a active_record model.
+#
+if Alchemy.user_class < ActiveRecord::Base
+  Alchemy.user_class.class_eval do
+    model_stamper
+    stampable stamper_class_name: Alchemy.user_class_name
+  end
+end