alchemy_cms 4.6.1 → 5.0.0

data/db/migrate/20200505215518_add_language_id_foreign_key_to_alchemy_pages.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+class AddLanguageIdForeignKeyToAlchemyPages < ActiveRecord::Migration[5.2]
+  def change
+    add_foreign_key :alchemy_pages, :alchemy_languages, column: :language_id
+    change_column_null :alchemy_pages, :language_id, false, Alchemy::Language.default&.id
+  end
+end

data/db/migrate/20200511113603_add_menu_type_to_alchemy_nodes.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+class AddMenuTypeToAlchemyNodes < ActiveRecord::Migration[5.2]
+  class LocalNode < ActiveRecord::Base
+    self.table_name = :alchemy_nodes
+    acts_as_nested_set scope: :language_id
+
+    def self.root_for(node)
+      return node if node.parent_id.nil?
+
+      root_for(node.parent)
+    end
+  end
+
+  def up
+    add_column :alchemy_nodes, :menu_type, :string
+    LocalNode.all.each do |node|
+      root = LocalNode.root_for(node)
+      menu_type = root.name.parameterize.underscore
+      node.update(menu_type: menu_type)
+    end
+    change_column_null :alchemy_nodes, :menu_type, false
+  end
+
+  def down
+    remove_column :alchemy_nodes, :menu_type
+  end
+end

data/db/migrate/20200514091507_make_page_layoutpage_null_false.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+class MakePageLayoutpageNullFalse < ActiveRecord::Migration[5.2]
+  def change
+    change_column_null :alchemy_pages, :layoutpage, false, false
+  end
+end

data/db/migrate/20200519073500_remove_visible_from_alchemy_pages.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+class RemoveVisibleFromAlchemyPages < ActiveRecord::Migration[5.2]
+  class LocalPage < ActiveRecord::Base
+    self.table_name = "alchemy_pages"
+
+    scope :invisible, -> { where(visible: [false, nil]) }
+    scope :contentpages, -> { where(layoutpage: [false, nil]) }
+  end
+
+  def up
+    if LocalPage.invisible.contentpages.where.not(parent_id: nil).any?
+      abort "You have invisible pages in your database! " \
+            "Please re-structure your page tree before running this migration. " \
+            "You might also downgrade to Alchemy 4.6 and " \
+            "run the `alchemy:upgrade:4.6:restructure_page_tree` rake task."
+    end
+
+    remove_column :alchemy_pages, :visible
+  end
+
+  def down
+    add_column :alchemy_pages, :visible, :boolean, default: false
+  end
+end

data/lib/alchemy/admin/locale.rb

@@ -47,6 +47,7 @@ module Alchemy
       # Try to get the locale from user settings.
       def locale_from_user
         return if !current_alchemy_user
+
         if user_has_preferred_language?
           current_alchemy_user.language
         end
@@ -55,6 +56,7 @@ module Alchemy
       # Checks if the +current_alchemy_user+ has a preferred language set or not.
       def user_has_preferred_language?
         return if !current_alchemy_user
+
         current_alchemy_user.respond_to?(:language) &&
           current_alchemy_user.language.present? &&
           current_alchemy_user.language.respond_to?(:to_sym)
@@ -62,7 +64,7 @@ module Alchemy
 
       # Try to get the locale from browser headers.
       def locale_from_browser
-        request.env['HTTP_ACCEPT_LANGUAGE'].try(:scan, /\A[a-z]{2}/).try(:first)
+        request.env["HTTP_ACCEPT_LANGUAGE"].try(:scan, /\A[a-z]{2}/).try(:first)
       end
     end
   end

data/lib/alchemy/admin/preview_url.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+require "uri"
+
+module Alchemy
+  module Admin
+    # = Preview window URL configuration
+    #
+    # By default Alchemy uses its internal page preview renderer,
+    # but you can configure it to be any URL instead.
+    #
+    # Basic Auth is supported.
+    #
+    # == Example config/alchemy/config.yml
+    #
+    #     preview:
+    #       host: https://www.my-static-site.com
+    #       auth:
+    #         username: <%= ENV["BASIC_AUTH_USERNAME"] %>
+    #         password: <%= ENV["BASIC_AUTH_PASSWORD"] %>
+    #
+    # Preview config per site is supported as well.
+    #
+    # == Example config/alchemy/config.yml
+    #
+    #     preview:
+    #       My site name:
+    #         host: https://www.my-static-site.com
+    #         auth:
+    #           username: <%= ENV["BASIC_AUTH_USERNAME"] %>
+    #           password: <%= ENV["BASIC_AUTH_PASSWORD"] %>
+    #
+    class PreviewUrl
+      class MissingProtocolError < StandardError; end
+
+      def initialize(routes:)
+        @routes = routes.url_helpers
+      end
+
+      def url_for(page)
+        @preview_config = preview_config_for(page)
+
+        if @preview_config && uri
+          uri_class.build(
+            host: uri.host,
+            path: page.url_path,
+            userinfo: userinfo,
+          ).to_s
+        else
+          routes.admin_page_path(page)
+        end
+      end
+
+      private
+
+      attr_reader :routes
+
+      def preview_config_for(page)
+        preview_config = Alchemy::Config.get(:preview)
+        return unless preview_config
+
+        preview_config[page.site.name] || preview_config
+      end
+
+      def uri
+        return unless @preview_config["host"]
+
+        URI(@preview_config["host"])
+      end
+
+      def uri_class
+        if uri.class == URI::Generic
+          raise MissingProtocolError, "Please provide the protocol with preview['host']"
+        else
+          uri.class
+        end
+      end
+
+      def userinfo
+        auth = @preview_config["auth"]
+        auth ? "#{auth["username"]}:#{auth["password"]}" : nil
+      end
+    end
+  end
+end

data/lib/alchemy/auth_accessors.rb

@@ -53,13 +53,13 @@ module Alchemy
 
   # Defaults
   #
-  @@user_class_name = 'User'
+  @@user_class_name = "User"
   @@user_class_primary_key = :id
-  @@current_user_method = 'current_user'
-  @@signup_path = '/signup'
-  @@login_path = '/login'
-  @@logout_path = '/logout'
-  @@logout_method = 'delete'
+  @@current_user_method = "current_user"
+  @@signup_path = "/signup"
+  @@login_path = "/login"
+  @@logout_path = "/logout"
+  @@logout_method = "delete"
 
   # Returns the user class
   #
@@ -76,8 +76,9 @@ module Alchemy
   # Prefix with :: when getting to avoid constant name conflicts
   def self.user_class_name
     if !@@user_class_name.is_a?(String)
-      raise TypeError, 'Alchemy.user_class_name must be a String, not a Class.'
+      raise TypeError, "Alchemy.user_class_name must be a String, not a Class."
     end
+
     "::#{@@user_class_name}"
   end
 

data/lib/alchemy/cache_digests/template_tracker.rb

@@ -14,10 +14,10 @@ module Alchemy
       def dependencies
         case @name.to_s
         when /^alchemy\/pages\/show/
-          PageLayout.all.map { |p| "alchemy/page_layouts/_#{p['name']}" }
+          PageLayout.all.map { |p| "alchemy/page_layouts/_#{p["name"]}" }
         when /^alchemy\/page_layouts\/_(\w+)/
           page_layout = PageLayout.get($1)
-          layout_elements = page_layout.fetch('elements', [])
+          layout_elements = page_layout.fetch("elements", [])
           layout_elements.map { |name| "alchemy/elements/_#{name}_view" } +
             layout_elements.map { |name| "alchemy/elements/_#{name}" }
         when /^alchemy\/elements\/_(\w+)_view/, /^alchemy\/elements\/_(\w+)/
@@ -32,9 +32,10 @@ module Alchemy
       private
 
       def essence_types(name)
-        element = Element.definitions.detect { |e| e['name'] == name }
+        element = Element.definitions.detect { |e| e["name"] == name }
         return [] unless element
-        element.fetch('contents', []).collect { |c| c['type'] }
+
+        element.fetch("contents", []).collect { |c| c["type"] }
       end
     end
   end

data/lib/alchemy/config.rb

@@ -32,9 +32,7 @@ module Alchemy
       # any not nil value is the new default
       def deprecated_configs
         {
-          url_nesting: true,
-          require_ssl: nil,
-          auto_logout_time: nil,
+          redirect_to_public_child: nil,
         }
       end
 
@@ -78,11 +76,11 @@ module Alchemy
         if deprecated_configs.key?(name.to_sym)
           config = deprecated_configs[name.to_sym]
           if config.nil?
-            Alchemy::Deprecation.warn("#{name} configuration is deprecated and will be removed from Alchemy 5.0")
+            Alchemy::Deprecation.warn("#{name} configuration is deprecated and will be removed from Alchemy 5.1")
           else
             value = show[name.to_s]
             if value != config
-              Alchemy::Deprecation.warn("Setting #{name} configuration to #{value} is deprecated and will be always #{config} in Alchemy 5.0")
+              Alchemy::Deprecation.warn("Setting #{name} configuration to #{value} is deprecated and will be always #{config} in Alchemy 5.1")
             end
           end
         end

data/lib/alchemy/configuration_methods.rb

@@ -28,7 +28,9 @@ module Alchemy
     # matches the current I18n.locale then the prefix os omitted.
     # Also, if only one published language exists.
     #
-    def prefix_locale?(locale = Language.current.code)
+    def prefix_locale?(locale = Language.current&.code)
+      return false unless locale
+
       multi_language? && locale != ::I18n.default_locale.to_s
     end
 

data/lib/alchemy/controller_actions.rb

@@ -8,7 +8,7 @@ module Alchemy
       before_action :set_current_alchemy_site
       before_action :set_alchemy_language
 
-      helper 'alchemy/pages'
+      helper "alchemy/pages"
 
       helper_method :current_alchemy_user,
         :alchemy_user_signed_in?,
@@ -36,6 +36,7 @@ module Alchemy
     def current_alchemy_user
       current_user_method = Alchemy.current_user_method
       raise NoCurrentUserFoundError if !respond_to?(current_user_method, true)
+
       send current_user_method
     end
 
@@ -66,8 +67,8 @@ module Alchemy
       else
         # find the best language and remember it for later
         @language = load_alchemy_language_from_params ||
-                    load_alchemy_language_from_session ||
-                    Language.default
+          load_alchemy_language_from_session ||
+          Language.default
       end
       store_current_alchemy_language(@language)
     end
@@ -81,7 +82,7 @@ module Alchemy
     # Load language from session if it's present on current site.
     # Otherwise return nil so we can load the default language from current site.
     def load_alchemy_language_from_session
-      if session[:alchemy_language_id].present?
+      if session[:alchemy_language_id].present? && Site.current
         Site.current.languages.find_by(id: session[:alchemy_language_id])
       end
     end
@@ -96,7 +97,7 @@ module Alchemy
     # Also stores language in +Language.current+
     #
     def store_current_alchemy_language(language)
-      if language && language.id
+      if language&.id
         session[:alchemy_language_id] = language.id
         Language.current = language
       end

data/lib/alchemy/deprecation.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Alchemy
-  Deprecation = ActiveSupport::Deprecation.new('5.0', 'Alchemy')
+  Deprecation = ActiveSupport::Deprecation.new("5.1", "Alchemy")
 end

data/lib/alchemy/elements_finder.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'alchemy/logger'
+require "alchemy/logger"
 
 module Alchemy
   # Loads elements from given page
@@ -86,7 +86,7 @@ module Alchemy
         Alchemy::Page.find_by(
           language: Alchemy::Language.current,
           page_layout: page_or_layout,
-          restricted: false
+          restricted: false,
         )
       end
     end
@@ -104,10 +104,10 @@ module Alchemy
 
     def random_function
       case ActiveRecord::Base.connection_config[:adapter]
-      when 'postgresql', 'sqlite3'
-        then 'RANDOM()'
+      when "postgresql", "sqlite3"
+        "RANDOM()"
       else
-        'RAND()'
+        "RAND()"
       end
     end
   end

data/lib/alchemy/engine.rb

@@ -1,32 +1,47 @@
+# frozen_string_literal: true
 module Alchemy
   class Engine < Rails::Engine
     isolate_namespace Alchemy
-    engine_name 'alchemy'
-    config.mount_at = '/'
+    engine_name "alchemy"
+    config.mount_at = "/"
 
-    initializer 'alchemy.lookup_context' do
-      Alchemy::LOOKUP_CONTEXT = ActionView::LookupContext.new(Rails.root.join('app', 'views', 'alchemy'))
+    initializer "alchemy.lookup_context" do
+      Alchemy::LOOKUP_CONTEXT = ActionView::LookupContext.new(Rails.root.join("app", "views", "alchemy"))
     end
 
-    initializer 'alchemy.dependency_tracker' do
+    initializer "alchemy.admin.preview_url" do
+      Alchemy::Admin::PREVIEW_URL = Alchemy::Admin::PreviewUrl.new(routes: Alchemy::Engine.routes)
+    end
+
+    initializer "alchemy.dependency_tracker" do
       [:erb, :slim, :haml].each do |handler|
         ActionView::DependencyTracker.register_tracker(handler, CacheDigests::TemplateTracker)
       end
     end
 
-    initializer 'alchemy.non_digest_assets' do
+    initializer "alchemy.non_digest_assets" do
       NonStupidDigestAssets.whitelist += [/^tinymce\//]
     end
 
     # Gutentag downcases all tgas before save.
     # We support having tags with uppercase characters.
     # The Gutentag search is case insensitive.
-    initializer 'alchemy.gutentag_normalizer' do
+    initializer "alchemy.gutentag_normalizer" do
       Gutentag.normaliser = ->(value) { value.to_s }
     end
 
+    # Custom Ransack sort arrows
+    initializer "alchemy.ransack" do
+      Ransack.configure do |config|
+        config.custom_arrows = {
+          up_arrow: '<i class="fa fas fa-xs fa-arrow-up"></i>',
+          down_arrow: '<i class="fa fas fa-xs fa-arrow-down"></i>',
+        }
+      end
+    end
+
     config.after_initialize do
-      require_relative './userstamp'
+      require_relative "./userstamp"
     end
   end
 end

data/lib/alchemy/errors.rb

@@ -23,13 +23,6 @@ module Alchemy
     end
   end
 
-  class DefaultLanguageNotDeletable < StandardError
-    # Raised if one tries to delete the default language.
-    def message
-      "Default language is not deletable!"
-    end
-  end
-
   class ElementDefinitionError < StandardError
     # Raised if element definition can not be found.
     def initialize(attributes)

data/lib/alchemy/essence.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'active_record'
+require "active_record"
 
 module Alchemy #:nodoc:
   # A bogus association that skips eager loading for essences not having an ingredient association
@@ -40,7 +40,7 @@ module Alchemy #:nodoc:
         register_as_essence_association!
 
         configuration = {
-          ingredient_column: 'body'
+          ingredient_column: "body",
         }.update(options)
 
         @_classes_with_ingredient_association ||= []
@@ -48,7 +48,7 @@ module Alchemy #:nodoc:
         class_eval <<-RUBY, __FILE__, __LINE__ + 1
           attr_writer :validation_errors
           include Alchemy::Essence::InstanceMethods
-          stampable stamper_class_name: Alchemy.user_class_name
+
           validate :validate_ingredient, on: :update, if: -> { validations.any? }
 
           has_one :content, as: :essence, class_name: "Alchemy::Content", inverse_of: :essence
@@ -62,7 +62,7 @@ module Alchemy #:nodoc:
           delegate :trashed?,    to: :element, allow_nil: true
           delegate :public?,     to: :element, allow_nil: true
 
-          after_update :touch_content
+          after_save :touch_element
 
           def acts_as_essence_class
             #{name}
@@ -109,7 +109,7 @@ module Alchemy #:nodoc:
       def register_as_essence_association!
         klass_name = model_name.to_s
         arguments = [:has_many, klass_name.demodulize.tableize.to_sym, through: :contents,
-          source: :essence, source_type: klass_name]
+                                                                       source: :essence, source_type: klass_name]
         %w(Page Element).each { |k| "Alchemy::#{k}".constantize.send(*arguments) }
       end
     end
@@ -171,7 +171,7 @@ module Alchemy #:nodoc:
       end
 
       def validations
-        @validations ||= definition.present? ? definition['validate'] || [] : []
+        @validations ||= definition.present? ? definition["validate"] || [] : []
       end
 
       def validation_errors
@@ -187,6 +187,7 @@ module Alchemy #:nodoc:
 
       def validate_uniqueness(validate = true)
         return if !validate || !public?
+
         if duplicates.any?
           errors.add(ingredient_column, :taken)
           validation_errors << :taken
@@ -194,7 +195,7 @@ module Alchemy #:nodoc:
       end
 
       def validate_format(format)
-        matcher = Config.get('format_matchers')[format] || format
+        matcher = Config.get("format_matchers")[format] || format
         if ingredient.to_s.match(Regexp.new(matcher)).nil?
           errors.add(ingredient_column, :invalid)
           validation_errors << :invalid
@@ -216,7 +217,7 @@ module Alchemy #:nodoc:
         end
       end
 
-      # Returns the value stored from the database column that is configured as ingredient column.
+      # Sets the value stored in the database column that is configured as ingredient column.
       def ingredient=(value)
         if respond_to?(ingredient_setter_method)
           send(ingredient_setter_method, value)
@@ -225,19 +226,19 @@ module Alchemy #:nodoc:
 
       # Returns the setter method for ingredient column
       def ingredient_setter_method
-        ingredient_column.to_s + '='
+        ingredient_column.to_s + "="
       end
 
       # Essence definition from config/elements.yml
       def definition
         return {} if element.nil? || element.content_definitions.nil?
-        element.content_definitions.detect { |c| c['name'] == content.name } || {}
+
+        element.content_definitions.detect { |c| c["name"] == content.name } || {}
       end
 
-      # Touch content. Called after update.
-      def touch_content
-        return nil if content.nil?
-        content.touch
+      # Touches element. Called after save.
+      def touch_element
+        element&.touch
       end
 
       # Returns the first x (default 30) characters of ingredient for the Element#preview_text method.
@@ -247,11 +248,11 @@ module Alchemy #:nodoc:
       end
 
       def open_link_in_new_window?
-        respond_to?(:link_target) && link_target == 'blank'
+        respond_to?(:link_target) && link_target == "blank"
       end
 
       def partial_name
-        self.class.name.split('::').last.underscore
+        self.class.name.split("::").last.underscore
       end
 
       def acts_as_essence?