alchemy_cms 4.6.1 → 5.0.0

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

data/lib/alchemy/paths.rb

@@ -29,6 +29,6 @@ module Alchemy
 
   # Defaults
   #
-  @@admin_path = 'admin'
+  @@admin_path = "admin"
   @@admin_constraints = {}
 end

data/lib/alchemy/permissions.rb

@@ -36,7 +36,7 @@ module Alchemy
     module GuestUser
       def alchemy_guest_user_rules
         can([:show, :download], Alchemy::Attachment) { |a| !a.restricted? }
-        can :see,               Alchemy::Page,       restricted: false, visible: true
+        can :see, Alchemy::Page, restricted: false
 
         can :read, Alchemy::Content, Alchemy::Content.available.not_restricted do |c|
           c.public? && !c.restricted? && !c.trashed?
@@ -64,7 +64,7 @@ module Alchemy
 
         # Resources
         can [:show, :download], Alchemy::Attachment
-        can :see,               Alchemy::Page, restricted: true, visible: true
+        can :see, Alchemy::Page, restricted: true
 
         can :read, Alchemy::Content, Alchemy::Content.available do |c|
           c.public? && !c.trashed?
@@ -99,7 +99,7 @@ module Alchemy
           :alchemy_admin_pages,
           :alchemy_admin_pictures,
           :alchemy_admin_tags,
-          :alchemy_admin_users
+          :alchemy_admin_users,
         ]
 
         # Controller actions
@@ -137,7 +137,7 @@ module Alchemy
         # Navigation
         can :index, [
           :alchemy_admin_languages,
-          :alchemy_admin_users
+          :alchemy_admin_users,
         ]
 
         # Controller actions
@@ -150,7 +150,7 @@ module Alchemy
           :flush,
           :order,
           :sort,
-          :switch_language
+          :switch_language,
         ], Alchemy::Page
 
         # Resources which may be locked via template permissions
@@ -164,7 +164,7 @@ module Alchemy
         can([
           :create,
           :destroy,
-          :publish
+          :publish,
         ], Alchemy::Page) { |p| p.editable_by?(@user) }
 
         can :manage, Alchemy::Picture
@@ -200,6 +200,7 @@ module Alchemy
 
     def user_role_rules
       return alchemy_guest_user_rules if @user.alchemy_roles.blank?
+
       @user.alchemy_roles.each do |role|
         exec_role_rules(role)
       end

data/lib/alchemy/resource.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require 'active_support'
-require 'active_support/core_ext'
-require 'active_support/inflector'
+require "active_support"
+require "active_support/core_ext"
+require "active_support/inflector"
 
 module Alchemy
   # = Alchemy::Resource
@@ -101,8 +101,8 @@ module Alchemy
     attr_accessor :resource_relations, :model_associations
     attr_reader :model
 
-    DEFAULT_SKIPPED_ATTRIBUTES = %w(id updated_at created_at creator_id updater_id)
-    DEFAULT_SKIPPED_ASSOCIATIONS = %w(creator updater)
+    DEFAULT_SKIPPED_ATTRIBUTES = %w(id created_at creator_id)
+    DEFAULT_SKIPPED_ASSOCIATIONS = %w(creator)
     SEARCHABLE_COLUMN_TYPES = [:string, :text]
 
     def initialize(controller_path, module_definition = nil, custom_model = nil)
@@ -113,13 +113,14 @@ module Alchemy
         if !model.respond_to?(:reflect_on_all_associations)
           raise MissingActiveRecordAssociation
         end
+
         store_model_associations
         map_relations
       end
     end
 
     def resource_array
-      @_resource_array ||= controller_path_array.reject { |el| el == 'admin' }
+      @_resource_array ||= controller_path_array.reject { |el| el == "admin" }
     end
 
     def resources_name
@@ -138,7 +139,7 @@ module Alchemy
       @_namespaced_resources_name ||= begin
         resource_name_array = resource_array.dup
         resource_name_array.delete(engine_name) if in_engine?
-        resource_name_array.join('_')
+        resource_name_array.join("_")
       end
     end
 
@@ -152,6 +153,7 @@ module Alchemy
     #
     def model_association_names
       return unless model_associations
+
       model_associations.map do |assoc|
         assoc.name.to_sym
       end
@@ -160,14 +162,22 @@ module Alchemy
     def attributes
       @_attributes ||= model.columns.collect do |col|
         next if skipped_attributes.include?(col.name)
+
         {
           name: col.name,
           type: resource_column_type(col),
-          relation: resource_relation(col.name)
+          relation: resource_relation(col.name),
         }.delete_if { |_k, v| v.nil? }
       end.compact
     end
 
+    def sorted_attributes
+      @_sorted_attributes ||= attributes.
+        sort_by  { |attr| attr[:name] == "name" ? 0 : 1 }.
+        sort_by! { |attr| attr[:type] == :boolean ? 1 : 0 }.
+        sort_by! { |attr| attr[:name] == "updated_at" ? 1 : 0 }
+    end
+
     def editable_attributes
       attributes.reject { |h| restricted_attributes.map(&:to_s).include?(h[:name].to_s) }
     end
@@ -197,10 +207,10 @@ module Alchemy
     end
 
     def engine_name
-      @module_definition && @module_definition['engine_name']
+      @module_definition && @module_definition["engine_name"]
     end
 
-    # Returns a help text for resource's form
+    # Returns a help text for resource's form or nil if no help text is available
     #
     # === Example:
     #
@@ -213,7 +223,7 @@ module Alchemy
     def help_text_for(attribute)
       ::I18n.translate!(attribute[:name], scope: [:alchemy, :resource_help_texts, resource_name])
     rescue ::I18n::MissingTranslationData
-      false
+      nil
     end
 
     # Return attributes that should be viewable but not editable.
@@ -254,16 +264,16 @@ module Alchemy
     def searchable_relation_attribute(attribute)
       {
         name: "#{attribute[:relation][:model_association].name}_#{attribute[:relation][:attr_method]}",
-        type: attribute[:relation][:attr_type]
+        type: attribute[:relation][:attr_type],
       }
     end
 
     def guess_model_from_controller_path
-      resource_array.join('/').classify.constantize
+      resource_array.join("/").classify.constantize
     end
 
     def controller_path_array
-      @controller_path.split('/')
+      @controller_path.split("/")
     end
 
     def namespace_diff
@@ -286,7 +296,7 @@ module Alchemy
     def map_relations
       self.resource_relations = {}
       model.alchemy_resource_relations.each do |name, options|
-        name = name.to_s.gsub(/_id$/, '') # ensure that we don't have an id
+        name = name.to_s.gsub(/_id$/, "") # ensure that we don't have an id
         association = association_from_relation_name(name)
         foreign_key = association.options[:foreign_key] || "#{association.name}_id".to_sym
         resource_relations[foreign_key] = options.merge(model_association: association, name: name)