alchemy_cms 4.5.0 → 5.0.0.rc1

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?

data/lib/alchemy/filetypes.rb

@@ -8,7 +8,7 @@ module Alchemy
       "audio/mpeg",
       "audio/mp4",
       "audio/wav",
-      "audio/x-wav"
+      "audio/x-wav",
     ]
 
     IMAGE_FILE_TYPES = [
@@ -17,7 +17,7 @@ module Alchemy
       "image/png",
       "image/svg+xml",
       "image/tiff",
-      "image/x-psd"
+      "image/x-psd",
     ]
 
     VCARD_FILE_TYPES = ["text/x-vcard", "application/vcard"]
@@ -29,18 +29,18 @@ module Alchemy
       "video/mpeg",
       "video/quicktime",
       "video/x-msvideo",
-      "video/x-ms-wmv"
+      "video/x-ms-wmv",
     ]
 
     TEXT_FILE_TYPES = [
       "application/rtf",
-      "text/plain"
+      "text/plain",
     ]
 
     EXCEL_FILE_TYPES = [
       "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
       "application/vnd.ms-excel",
-      "text/csv"
+      "text/csv",
     ]
   end
 end

data/lib/alchemy/forms/builder.rb

@@ -11,7 +11,7 @@ module Alchemy
         if object.respond_to?(:attribute_fixed?) && object.attribute_fixed?(attribute_name)
           options[:disabled] = true
           options[:input_html] = options.fetch(:input_html, {}).merge(
-            'data-alchemy-tooltip' => Alchemy.t(:attribute_fixed, attribute_name)
+            "data-alchemy-tooltip" => Alchemy.t(:attribute_fixed, attribute_name),
           )
         end
 
@@ -22,10 +22,10 @@ module Alchemy
       #
       def submit(label, options = {})
         options = {
-          wrapper_html: {class: 'submit'}
+          wrapper_html: {class: "submit"},
         }.update(options)
-        template.content_tag('div', options.delete(:wrapper_html)) do
-          template.content_tag('button', label, options.delete(:input_html))
+        template.content_tag("div", options.delete(:wrapper_html)) do
+          template.content_tag("button", label, options.delete(:input_html))
         end
       end
     end

data/lib/alchemy/hints.rb

@@ -35,7 +35,7 @@ module Alchemy
     # @return String
     #
     def hint
-      hint = definition['hint']
+      hint = definition["hint"]
       if hint == true
         Alchemy.t(name, scope: hint_translation_scope)
       else

data/lib/alchemy/i18n.rb

@@ -74,11 +74,12 @@ module Alchemy
 
       def humanize_default_string!(msg, options)
         return if options[:default].present?
+
         options[:default] = msg.is_a?(Symbol) ? msg.to_s.humanize : msg
       end
 
       def alchemy_scoped_scope(options)
-        default_scope = ['alchemy']
+        default_scope = ["alchemy"]
         case options[:scope]
         when Array
           default_scope + options[:scope]

data/lib/alchemy/install/tasks.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+require "thor"
+
+module Alchemy
+  module Install
+    class Tasks < Thor
+      include Thor::Actions
+
+      no_tasks do
+        def inject_routes(auto_accept = false)
+          return if File.read("./config/routes.rb").match?("mount Alchemy::Engine")
+
+          mountpoint = "/"
+          unless auto_accept
+            mountpoint = ask("- At which path do you want to mount Alchemy CMS at?", default: mountpoint)
+          end
+          sentinel = /\.routes\.draw do(?:\s*\|map\|)?\s*$/
+          inject_into_file "./config/routes.rb", "\n  mount Alchemy::Engine => '#{mountpoint}'\n", { after: sentinel, verbose: true }
+        end
+
+        def set_primary_language(auto_accept = false)
+          code = "en"
+          unless auto_accept
+            code = ask("- What is the language code of your site's primary language?", default: code)
+          end
+          name = "English"
+          unless auto_accept
+            name = ask("- What is the name of your site's primary language?", default: name)
+          end
+          gsub_file "./config/alchemy/config.yml", /default_language:\n\s\scode:\sen\n\s\sname:\sEnglish/m do
+            "default_language:\n  code: #{code}\n  name: #{name}"
+          end
+        end
+
+        def inject_seeder
+          append_file "./db/seeds.rb", "Alchemy::Seeder.seed!\n"
+        end
+      end
+    end
+  end
+end

data/lib/alchemy/modules.rb

@@ -4,7 +4,7 @@ module Alchemy
   module Modules
     mattr_accessor :alchemy_modules
 
-    @@alchemy_modules = YAML.load_file(File.expand_path('../../config/alchemy/modules.yml', __dir__))
+    @@alchemy_modules = YAML.load_file(File.expand_path("../../config/alchemy/modules.yml", __dir__))
 
     class << self
       def included(base)
@@ -28,11 +28,11 @@ module Alchemy
         definition_hash = module_definition.deep_stringify_keys
 
         ### Validate controller(s) existence
-        if definition_hash['navigation'].is_a?(Hash)
-          defined_controllers = [definition_hash['navigation']['controller']]
+        if definition_hash["navigation"].is_a?(Hash)
+          defined_controllers = [definition_hash["navigation"]["controller"]]
 
-          if definition_hash['navigation']['sub_navigation'].is_a?(Array)
-            defined_controllers.concat(definition_hash['navigation']['sub_navigation'].map{ |x| x['controller'] })
+          if definition_hash["navigation"]["sub_navigation"].is_a?(Array)
+            defined_controllers.concat(definition_hash["navigation"]["sub_navigation"].map{ |x| x["controller"] })
           end
 
           validate_controllers_existence(defined_controllers)
@@ -52,7 +52,7 @@ module Alchemy
           begin
             controller_name.constantize
           rescue NameError
-            raise "Error in AlchemyCMS module definition: '#{definition_hash['name']}'. Could not find the matching controller class #{controller_name.sub(/^::/, '')} for the specified controller: '#{controller_val}'"
+            raise "Error in AlchemyCMS module definition: '#{definition_hash["name"]}'. Could not find the matching controller class #{controller_name.sub(/^::/, "")} for the specified controller: '#{controller_val}'"
           end
         end
       end
@@ -66,11 +66,11 @@ module Alchemy
     def module_definition_for(name_or_params)
       case name_or_params
       when String
-        alchemy_modules.detect { |m| m['name'] == name_or_params }
+        alchemy_modules.detect { |m| m["name"] == name_or_params }
       when Hash
         name_or_params.stringify_keys!
         alchemy_modules.detect do |alchemy_module|
-          module_navi = alchemy_module.fetch('navigation', {})
+          module_navi = alchemy_module.fetch("navigation", {})
           definition_from_mainnavi(module_navi, name_or_params) ||
             definition_from_subnavi(module_navi, name_or_params)
         end
@@ -86,7 +86,7 @@ module Alchemy
     end
 
     def definition_from_subnavi(module_navi, params)
-      subnavi = module_navi['sub_navigation']
+      subnavi = module_navi["sub_navigation"]
       return if subnavi.nil?
 
       subnavi.any? do |navi|
@@ -95,15 +95,15 @@ module Alchemy
     end
 
     def controller_matches?(navi, params)
-      remove_slash(navi['controller']) == remove_slash(params['controller'])
+      remove_slash(navi["controller"]) == remove_slash(params["controller"])
     end
 
     def action_matches?(navi, params)
-      navi['action'] == params['action']
+      navi["action"] == params["action"]
     end
 
     def remove_slash(str)
-      str.gsub(/^\//, '')
+      str.gsub(/^\//, "")
     end
   end
 end

data/lib/alchemy/name_conversions.rb

@@ -10,17 +10,17 @@ module Alchemy
     # @returns String
     def convert_to_urlname(name)
       name
-        .gsub(/[äÄ]/, 'ae')
-        .gsub(/[üÜ]/, 'ue')
-        .gsub(/[öÖ]/, 'oe')
-        .gsub(/[ß]/, 'ss')
+        .gsub(/[äÄ]/, "ae")
+        .gsub(/[üÜ]/, "ue")
+        .gsub(/[öÖ]/, "oe")
+        .gsub(/[ß]/, "ss")
         .parameterize
     end
 
     # Converts a filename and suffix into a human readable name.
     #
     def convert_to_humanized_name(name, suffix)
-      name.gsub(/\.#{::Regexp.quote(suffix)}$/i, '').tr('_', ' ').strip
+      name.gsub(/\.#{::Regexp.quote(suffix)}$/i, "").tr("_", " ").strip
     end
   end
 end

data/lib/alchemy/on_page_layout/callbacks_runner.rb

@@ -18,6 +18,7 @@ module Alchemy
       def run_on_page_layout_callbacks
         OnPageLayout.callbacks.each do |page_layout, callbacks|
           next unless call_page_layout_callback_for?(page_layout)
+
           callbacks.each do |callback|
             if callback.respond_to?(:call)
               instance_eval(&callback)

data/lib/alchemy/page_layout.rb

@@ -37,7 +37,8 @@ module Alchemy
       #
       def get(name)
         return {} if name.blank?
-        all.detect { |a| a['name'].casecmp(name).zero? }
+
+        all.detect { |a| a["name"].casecmp(name).zero? }
       end
 
       def get_all_by_attributes(attributes)
@@ -66,7 +67,7 @@ module Alchemy
       #
       def layouts_with_own_for_select(page_layout_name, language_id, only_layoutpages = false)
         layouts = selectable_layouts(language_id, only_layoutpages)
-        if layouts.detect { |l| l['name'] == page_layout_name }.nil?
+        if layouts.detect { |l| l["name"] == page_layout_name }.nil?
           @map_array = [[human_layout_name(page_layout_name), page_layout_name]]
         else
           @map_array = []
@@ -87,9 +88,9 @@ module Alchemy
         @language_id = language_id
         all.select do |layout|
           if only_layoutpages
-            layout['layoutpage'] && layout_available?(layout)
+            layout["layoutpage"] && layout_available?(layout)
           else
-            !layout['layoutpage'] && layout_available?(layout)
+            !layout["layoutpage"] && layout_available?(layout)
           end
         end
       end
@@ -98,7 +99,7 @@ module Alchemy
       #
       def element_names_for(page_layout)
         if definition = get(page_layout)
-          definition.fetch('elements', [])
+          definition.fetch("elements", [])
         else
           Rails.logger.warn "\n+++ Warning: No layout definition for #{page_layout} found! in page_layouts.yml\n"
           []
@@ -118,7 +119,7 @@ module Alchemy
       #   The layout name
       #
       def human_layout_name(layout)
-        Alchemy.t(layout, scope: 'page_layout_names', default: layout.to_s.humanize)
+        Alchemy.t(layout, scope: "page_layout_names", default: layout.to_s.humanize)
       end
 
       private
@@ -126,13 +127,13 @@ module Alchemy
       # Returns true if the given layout is unique and not already taken or it should be hidden.
       #
       def layout_available?(layout)
-        !layout['hide'] && !already_taken?(layout) && available_on_site?(layout)
+        !layout["hide"] && !already_taken?(layout) && available_on_site?(layout)
       end
 
       # Returns true if this layout is unique and already taken by another page.
       #
       def already_taken?(layout)
-        layout['unique'] && page_with_layout_existing?(layout['name'])
+        layout["unique"] && page_with_layout_existing?(layout["name"])
       end
 
       # Returns true if one page already has the given layout
@@ -152,8 +153,10 @@ module Alchemy
       #     page_layouts: [default_intro]
       #
       def available_on_site?(layout)
+        return false unless Alchemy::Site.current
+
         Alchemy::Site.current.definition.blank? ||
-          Alchemy::Site.current.definition.fetch('page_layouts', []).include?(layout['name'])
+          Alchemy::Site.current.definition.fetch("page_layouts", []).include?(layout["name"])
       end
 
       # Reads the layout definitions from +config/alchemy/page_layouts.yml+.
@@ -162,21 +165,21 @@ module Alchemy
         if File.exist?(layouts_file_path)
           YAML.safe_load(ERB.new(File.read(layouts_file_path)).result, YAML_WHITELIST_CLASSES, [], true) || []
         else
-          raise LoadError, "Could not find page_layouts.yml file! Please run `rails generate alchemy:scaffold`"
+          raise LoadError, "Could not find page_layouts.yml file! Please run `rails generate alchemy:install`"
         end
       end
 
       # Returns the page_layouts.yml file path
       #
       def layouts_file_path
-        Rails.root.join 'config/alchemy/page_layouts.yml'
+        Rails.root.join "config/alchemy/page_layouts.yml"
       end
 
       # Maps given layouts for Rails select form helper.
       #
       def mapped_layouts_for_select(layouts)
         layouts.each do |layout|
-          @map_array << [human_layout_name(layout['name']), layout["name"]]
+          @map_array << [human_layout_name(layout["name"]), layout["name"]]
         end
         @map_array
       end