alchemy_cms 7.4.10 → 8.0.0.b

data/lib/alchemy/configurations/main.rb

@@ -0,0 +1,223 @@
+# frozen_string_literal: true
+
+require "alchemy/configuration"
+require "alchemy/configurations/default_language"
+require "alchemy/configurations/default_site"
+require "alchemy/configurations/format_matchers"
+require "alchemy/configurations/mailer"
+require "alchemy/configurations/page_cache"
+require "alchemy/configurations/preview"
+require "alchemy/configurations/sitemap"
+require "alchemy/configurations/uploader"
+require "alchemy/deprecation"
+
+module Alchemy
+  module Configurations
+    class Main < Alchemy::Configuration
+      # == This is the global Alchemy configuration class
+
+      # === Auto Log Out Time
+      #
+      # The amount of time of inactivity in minutes after which the user is kicked out of his current session.
+      #
+      # NOTE: This is only active in production environments
+      #
+      option :auto_logout_time, :integer, default: 30
+
+      # === Page caching
+      #
+      # Enable/Disable page caching globally.
+      #
+      # NOTE: You can enable/disable page caching for single Alchemy::Definitions in the page_layout.yml file.
+      #
+      option :cache_pages, :boolean, default: true
+
+      # === Page caching max age
+      #
+      # max-age [Integer] # The duration in seconds for which the page is cached before revalidation.
+      # stale-while-revalidate [Boolean] # If true, enables the stale-while-revalidate caching strategy.
+      configuration :page_cache, PageCache
+
+      # === Sitemap
+      #
+      # Alchemy creates a XML, Google compatible, sitemap for you.
+      #
+      # The url is: http://your-domain.tld/sitemap.xml
+      #
+      # ==== Config Options:
+      #
+      #   show_root [Boolean] # Show language root page in sitemap?
+      #   show_flag [Boolean] # Enables the Checkbox in Page#update overlay. So your customer can set the visibility of pages in the sitemap.
+      configuration :sitemap, Sitemap
+
+      # === Default items per page in admin views
+      #
+      # In Alchemy's Admin, change how many items you would get shown per page by Kaminari
+      option :items_per_page, :integer, default: 15
+
+      # === 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.
+      #
+      # 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.
+      #
+      # preview:
+      #   My site name:
+      #     host: https://www.my-static-site.com
+      #     auth:
+      #       username: <%= ENV["BASIC_AUTH_USERNAME"] %>
+      #       password: <%= ENV["BASIC_AUTH_PASSWORD"] %>
+      #
+      configuration :preview, Preview
+
+      # === Picture rendering settings
+      #
+      # Alchemy uses Dragonfly to render images. Settings for image rendering are specific to elements and are defined in elements.yml
+      #
+      # Example:
+      # - name: some_element
+      #   ingredients:
+      #   - role: some_picture
+      #     type: Picture
+      #     settings:
+      #       hint: true
+      #       crop: true  # turns on image cropping
+      #       size: '500x500' # image will be cropped to this size
+      #
+      # See http://markevans.github.com/dragonfly for further info.
+      #
+      # ==== Global Options:
+      #
+      #   output_image_quality      [Integer]       # If image gets rendered as JPG or WebP this is the quality setting for it. (Default 85)
+      #   preprocess_image_resize   [String]        # Use this option to resize images to the given size when they are uploaded to the image library. Downsizing example: '1000x1000>' (Default nil)
+      #   image_output_format       [String]        # The global image output format setting. (Default +original+)
+      #
+      # NOTE: You can always override the output format in the settings of your ingredients in elements.yml, I.E. {format: 'gif'}
+      #
+      option :output_image_quality, :integer, default: 85
+      alias_method :output_image_jpg_quality, :output_image_quality
+      deprecate output_image_jpg_quality: :output_image_quality, deprecator: Alchemy::Deprecation
+      alias_method :output_image_jpg_quality=, :output_image_quality=
+      deprecate "output_image_jpg_quality=": :output_image_quality=, deprecator: Alchemy::Deprecation
+      option :preprocess_image_resize, :string
+      option :image_output_format, :string, default: "original"
+      option :sharpen_images, :boolean, default: false
+
+      # This is used by the seeder to create the default site.
+      configuration :default_site, DefaultSite
+
+      # This is the default language when seeding.
+      configuration :default_language, DefaultLanguage
+
+      # === Mailer Settings:
+      #
+      # To send emails via contact forms, you can create your form fields here and set which fields are to be validated.
+      #
+      # === Validating fields:
+      #
+      # Pass the field name as a symbol and a message_id (will be translated) to :validate_fields:
+      #
+      # ==== Options:
+      #
+      #   page_layout_name:           [String] # A +Alchemy::PageDefinition+ name. Used to render the contactform on a page with this layout.
+      #   fields:                     [Array]  # An Array of fieldnames.
+      #   validate_fields:            [Array]  # An Array of fieldnames to be validated on presence.
+      #
+      # ==== Translating validation messages:
+      #
+      # The validation messages are passed through ::I18n.t so you can translate it in your language yml file.
+      #
+      # ==== Example:
+      #
+      #   de:
+      #     activemodel:
+      #       attributes:
+      #         alchemy/message:
+      #           firstname: Vorname
+      #
+      configuration :mailer, Mailer
+
+      # === User roles
+      #
+      # You can add own user roles.
+      #
+      # Further documentation for the auth system used please visit:
+      #
+      # https://github.com/ryanb/cancan/wiki
+      #
+      # ==== Translating User roles
+      #
+      # Userroles can be translated inside your the language yml file under:
+      #
+      #   alchemy:
+      #     user_roles:
+      #       rolename: Name of the role
+      #
+      option :user_roles, :string_list, default: %w[member author editor admin]
+
+      # === Uploader Settings
+      #
+      #   upload_limit       [Integer]    # Set an amount of files upload limit of files which can be uploaded at once. Set 0 for unlimited.
+      #   file_size_limit*   [Integer]    # Set a file size limit in mega bytes for a per file limit.
+      #
+      # *) Allow filetypes to upload. Pass * to allow all kind of files.
+      #
+      configuration :uploader, Uploader
+
+      # === Link Target Options
+      #
+      # Values for the link target selectbox inside the page link overlay.
+      # The value gets attached as a data-link-target attribute to the link.
+      #
+      # == Example:
+      #
+      # Open all links set to overlay inside an jQuery UI Dialog Window.
+      #
+      #   jQuery(a[data-link-target="overlay"]).dialog();
+      #
+      option :link_target_options, :string_list, default: %w[blank]
+
+      # === Format matchers
+      #
+      # Named aliases for regular expressions that can be used in various places.
+      # The most common use case is the format validation of ingredients, or attribute validations of your individual models.
+      #
+      # == Example:
+      #
+      #   validates_format_of :url, with: Alchemy.config.format_matchers.url
+      #
+      configuration :format_matchers, FormatMatchers
+
+      # The layout used for rendering the +alchemy/admin/pages#show+ action.
+      option :admin_page_preview_layout, :string, default: "application"
+
+      # The sizes for the preview size select in the page editor.
+      option :page_preview_sizes, :integer_list, default: [360, 640, 768, 1024, 1280, 1440]
+
+      # Enable full text search configuration
+      #
+      # It enables a searchable checkbox in the page form to toggle
+      # the searchable field. These information can used in a search
+      # plugin (e.g. https://github.com/AlchemyCMS/alchemy-pg_search).
+      #
+      # == Example
+      #
+      #     # config/initializers/alchemy.rb
+      #     Alchemy.config.page_searchable_checkbox = true
+      option :show_page_searchable_checkbox, :boolean, default: false
+
+      # The storage adapter for Pictures and Attachments
+      #
+      option :storage_adapter, :string, default: "dragonfly"
+    end
+  end
+end

data/lib/alchemy/configurations/page_cache.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Alchemy
+  module Configurations
+    class PageCache < Alchemy::Configuration
+      # === Page caching max age
+      #
+      # Control the max-age duration in seconds in the cache-control header.
+      #
+      option :max_age, :integer, default: 600
+
+      # === Page caching stale-while-revalidate
+      #
+      # Set stale-while-revalidate cache-control header.
+      #
+      option :stale_while_revalidate, :integer
+    end
+  end
+end

data/lib/alchemy/configurations/preview.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Alchemy
+  module Configurations
+    class Preview < Alchemy::Configuration
+      class PreviewAuth < Alchemy::Configuration
+        option :username, :string
+        option :password, :string
+      end
+
+      attr_reader :per_site_configs
+
+      def initialize(configuration = {})
+        @per_site_configs = []
+        configuration = configuration.with_indifferent_access
+        configuration.except(:host, :site_name, :auth).keys.each do |site_name|
+          @per_site_configs << Preview.new(configuration[site_name].merge(site_name: site_name))
+        end
+        super(configuration.slice(:host, :site_name, :auth))
+      end
+
+      option :site_name, :string, default: "*"
+      option :host, :string
+
+      configuration :auth, PreviewAuth
+
+      def for_site(site)
+        per_site_configs.detect { _1.site_name == site.name } || self
+      end
+    end
+  end
+end

data/lib/alchemy/configurations/sitemap.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Alchemy
+  module Configurations
+    class Sitemap < Alchemy::Configuration
+      option :show_root, :boolean, default: true
+      option :show_flag, :boolean, default: false
+    end
+  end
+end

data/lib/alchemy/configurations/uploader.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Alchemy
+  module Configurations
+    class Uploader < Alchemy::Configuration
+      class AllowedFileTypes < Alchemy::Configuration
+        option :alchemy_attachments, :string_list, default: ["*"]
+        option :alchemy_pictures, :string_list, default: %w[jpg jpeg gif png svg webp]
+
+        def set(configuration_hash)
+          super(configuration_hash.transform_keys { transform_key(_1) })
+        end
+
+        def get(key)
+          super(transform_key(key))
+        end
+        alias_method :[], :get
+
+        private
+
+        def transform_key(key)
+          key.to_s.tr("/", "_")
+        end
+      end
+
+      # Number of files that can be uploaded at once
+      option :upload_limit, :integer, default: 50
+      # Megabytes
+      option :file_size_limit, :integer, default: 100
+
+      configuration :allowed_filetypes, AllowedFileTypes
+    end
+  end
+end

data/lib/alchemy/engine.rb

@@ -16,13 +16,29 @@ module Alchemy
       end
     end
 
-    initializer "alchemy.non_digest_assets" do
-      NonStupidDigestAssets.whitelist += [/^tinymce\//]
+    initializer "alchemy.assets" do |app|
+      if defined?(Sprockets)
+        require_relative "../non_stupid_digest_assets"
+        NonStupidDigestAssets.whitelist += [/^tinymce\//]
+        app.config.assets.precompile << "alchemy_manifest.js"
+      end
     end
 
     initializer "alchemy.admin_stylesheets" do |app|
-      Alchemy.admin_stylesheets.each do |stylesheet|
-        app.config.assets.precompile << stylesheet
+      if defined?(Sprockets)
+        Alchemy.admin_stylesheets.each do |stylesheet|
+          app.config.assets.precompile << stylesheet
+        end
+      end
+    end
+
+    initializer "alchemy.propshaft" do |app|
+      if defined?(Propshaft)
+        if app.config.assets.server
+          # Monkey-patch Propshaft::Asset to enable access
+          # of TinyMCE assets without a hash digest.
+          require_relative "propshaft/tinymce_asset"
+        end
       end
     end
 
@@ -46,27 +62,36 @@ module Alchemy
       end
     end
 
-    initializer "alchemy.watch_definition_changes" do |app|
-      elements_reloader = app.config.file_watcher.new([ElementDefinition.definitions_file_path]) do
-        Rails.logger.info "[#{engine_name}] Reloading Element Definitions."
+    # All the initialization that needs to be re-triggered during reloads
+    config.to_prepare do
+      # Definition files
+      elements_reloader = Rails.application.config.file_watcher.new([ElementDefinition.definitions_file_path]) do
+        Rails.logger.info "[alchemy] Reloading Element Definitions."
         ElementDefinition.reset!
       end
-      page_layouts_reloader = app.config.file_watcher.new([PageLayout.layouts_file_path]) do
-        Rails.logger.info "[#{engine_name}] Reloading Page Layouts."
-        PageLayout.reset!
+      page_layouts_reloader = Rails.application.config.file_watcher.new([PageDefinition.layouts_file_path]) do
+        Rails.logger.info "[alchemy] Reloading Page Layouts."
+        PageDefinition.reset!
       end
       [elements_reloader, page_layouts_reloader].each do |reloader|
-        app.reloaders << reloader
-        app.reloader.to_run do
+        Rails.application.reloaders << reloader
+        Rails.application.reloader.to_run do
           reloader.execute_if_updated
         end
       end
-    end
 
-    # Gutentag downcases all tags before save
-    # and Gutentag validations are not case sensitive.
-    # But we support having tags with uppercase characters.
-    config.to_prepare do
+      # The storage adapter for Pictures and Attachments
+      #
+      # Chose between 'active_storage' (default) or 'dragonfly' (legacy)
+      #
+      # Can be set via 'ALCHEMY_STORAGE_ADAPTER' env var.
+      Alchemy.storage_adapter = Alchemy::StorageAdapter.new(
+        ENV.fetch("ALCHEMY_STORAGE_ADAPTER", Alchemy.config.storage_adapter)
+      )
+
+      # Gutentag downcases all tags before save
+      # and Gutentag validations are not case sensitive.
+      # But we support having tags with uppercase characters.
       Gutentag.normaliser = ->(value) { value.to_s }
       Gutentag.tag_validations = Alchemy::TagValidations
     end
@@ -79,13 +104,36 @@ module Alchemy
           down_arrow: '<alchemy-icon name="arrow-down" size="1x"></alchemy-icon>'
         }
       end
+
+      ActiveSupport.on_load(:active_storage_blob) do
+        ActiveStorage::Blob.define_singleton_method(:ransackable_attributes) do |_auth_object|
+          %w[filename]
+        end
+      end
+    end
+
+    # Load Alchemy configuration from YAML files
+    # in config/alchemy/config.yml and config/alchemy/#{Rails.env}.config.yml
+    # if they exist.
+    # This has to be done before any app initializers are loaded, so that
+    # the configuration is available in all initializers.
+    initializer "alchemy.config_yml", before: :load_config_initializers do |app|
+      config_directory = Rails.root.join("config", "alchemy")
+      main_config = config_directory.join("config.yml")
+      env_specific_config = config_directory.join("#{Rails.env}.config.yml")
+      if File.exist?(main_config)
+        Alchemy.config.set_from_yaml(main_config)
+      end
+      if File.exist?(env_specific_config)
+        Alchemy.config.set_from_yaml(env_specific_config)
+      end
     end
 
     config.after_initialize do
       if Alchemy.user_class
         ActiveSupport.on_load(:active_record) do
           Alchemy.user_class.model_stamper
-          Alchemy.user_class.stampable(stamper_class_name: Alchemy.user_class.name)
+          Alchemy.user_class.stampable(stamper_class_name: Alchemy.user_class_name)
         end
       end
 
@@ -96,14 +144,23 @@ module Alchemy
       end
     end
 
-    initializer "alchemy.webp-mime_type" do
-      # Rails does not know anything about webp even in 2022
-      unless Mime::Type.lookup_by_extension(:webp)
-        Mime::Type.register("image/webp", :webp)
-      end
+    initializer "alchemy.webp-mime_type" do |app|
+      webp = "image/webp"
+
       # Dragonfly uses Rack to read the mime type and guess what
+      # Rack 3.0 has this included, but Rails 8 still allows Rack 2.2
       unless Rack::Mime::MIME_TYPES[".webp"]
-        Rack::Mime::MIME_TYPES[".webp"] = "image/webp"
+        Rack::Mime::MIME_TYPES[".webp"] = webp
+      end
+
+      # ActiveStorage 7.2 adds support for webp, but we still support Rails 7.1
+      if app.config.active_storage
+        unless app.config.active_storage.web_image_content_types.include? webp
+          app.config.active_storage.web_image_content_types += [webp]
+        end
+        unless app.config.active_storage.content_types_allowed_inline.include? webp
+          app.config.active_storage.content_types_allowed_inline += [webp]
+        end
       end
     end
   end

data/lib/alchemy/hints.rb

@@ -35,7 +35,7 @@ module Alchemy
     # @return String
     #
     def hint
-      hint = definition[:hint]
+      hint = attributes[:hint]
       if hint == true
         Alchemy.t(hint_translation_attribute, scope: hint_translation_scope)
       else
@@ -43,9 +43,9 @@ module Alchemy
       end
     end
 
-    # Returns true if the element has a hint defined
+    # Returns true if the definition has a hint defined
     def has_hint?
-      !!definition[:hint]
+      !!attributes[:hint]
     end
 
     private
@@ -53,9 +53,5 @@ module Alchemy
     def hint_translation_attribute
       name
     end
-
-    def hint_translation_scope
-      "#{self.class.model_name.to_s.demodulize.downcase}_hints"
-    end
   end
 end

data/lib/alchemy/install/tasks.rb

@@ -22,18 +22,6 @@ module Alchemy
             {after: SENTINEL, verbose: true}
         end
 
-        def set_primary_language(code: "en", name: "English", auto_accept: false)
-          unless auto_accept
-            code = ask("- What is the language code of your site's primary language?", default: code)
-          end
-          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
           seed_file = Rails.root.join("db", "seeds.rb")
           args = [seed_file, "Alchemy::Seeder.seed!\n"]

data/lib/alchemy/on_page_layout.rb

@@ -9,7 +9,7 @@ module Alchemy
   # Pass a block or method name in which you have the +@page+ object available and can do
   # everything as if you were in a normal controller action.
   #
-  # You can pass a +Alchemy::PageLayout+ name, an array of names, or +:all+ to
+  # You can pass a +Alchemy::PageDefinition+ name, an array of names, or +:all+ to
   # evaluate the callback on either some specific or all the pages.
   #
   # == Example:
@@ -56,7 +56,7 @@ module Alchemy
     # Pass a block or method name in which you have the +@page+ object available and can do
     # everything as if you were in a normal controller action.
     #
-    # Pass a +Alchemy::PageLayout+ name, an array of names, or +:all+ to
+    # Pass a +Alchemy::PageDefinition+ name, an array of names, or +:all+ to
     # evaluate the callback on either some specific or all the pages.
     #
     def on_page_layout(page_layouts, callback = nil, &block)

data/lib/alchemy/propshaft/tinymce_asset.rb

@@ -0,0 +1,15 @@
+require "propshaft/asset"
+
+module Alchemy
+  module Propshaft
+    module TinymceAsset
+      # Allow TinyMCE assets to be accessed (in development mode) without a digest
+      def fresh?(digest)
+        super ||
+          (digest.blank? && logical_path.to_s.starts_with?("tinymce/"))
+      end
+    end
+  end
+end
+
+Propshaft::Asset.prepend Alchemy::Propshaft::TinymceAsset

data/lib/alchemy/seeder.rb

@@ -116,7 +116,7 @@ module Alchemy
       # If no languages are present, create a default language based
       # on the host app's Alchemy configuration.
       def create_default_language!
-        default_language = Alchemy::Config.get(:default_language)
+        default_language = Alchemy.config.default_language
         if default_language
           Alchemy::Language.create!(
             name: default_language["name"],
@@ -134,7 +134,7 @@ module Alchemy
       end
 
       def create_default_site!
-        default_site = Alchemy::Config.get(:default_site)
+        default_site = Alchemy.config.default_site
         if default_site
           Alchemy::Site.create!(name: default_site["name"], host: default_site["host"])
         else

data/lib/alchemy/tasks/tidy.rb

@@ -73,6 +73,24 @@ module Alchemy
         log "Deleted #{count} duplicate legacy URLs"
       end
 
+      def remove_legacy_essence_tables
+        puts "\n## Removing legacy essence tables"
+        matching_tables = ActiveRecord::Base.connection.tables.select do |table|
+          table.start_with?("alchemy_essence_")
+        end
+        if matching_tables.length.zero?
+          log "No legacy essence tables found", :skip
+          nil
+        else
+          matching_tables.each do |table|
+            ActiveRecord::Base.connection.drop_table(table, if_exists: true)
+            print "."
+          end
+          puts "\n"
+          log "Deleted #{matching_tables.length} legacy essence tables"
+        end
+      end
+
       private
 
       def destroy_orphaned_records(records, class_name)

data/lib/alchemy/tasks/usage.rb

@@ -11,8 +11,8 @@ module Alchemy
           .group(:name)
           .order("count DESC, name ASC")
           .map { |e| {"name" => e.name, "count" => e.count} }
-        Alchemy::Element.definitions.reject { |definition| res.map { |e| e["name"] }.include? definition["name"] }.sort_by { |d| d["name"] }.each do |definition|
-          res << {"name" => definition["name"], "count" => 0}
+        Alchemy::Element.definitions.reject { |definition| res.map { |e| e["name"] }.include?(definition.name) }.sort_by(&:name).each do |definition|
+          res << {"name" => definition.name, "count" => 0}
         end
         res
       end
@@ -23,8 +23,8 @@ module Alchemy
           .group(:page_layout)
           .order("count DESC, page_layout ASC")
           .map { |p| {"page_layout" => p.page_layout, "count" => p.count} }
-        Alchemy::PageLayout.all.reject { |page_layout| res.map { |p| p["page_layout"] }.include? page_layout["name"] }.sort_by { |d| d["name"] }.each do |page_layout|
-          res << {"page_layout" => page_layout["name"], "count" => 0}
+        Alchemy::PageDefinition.all.reject { |page_layout| res.map { |p| p["page_layout"] }.include?(page_layout.name) }.sort_by(&:name).each do |page_layout|
+          res << {"page_layout" => page_layout.name, "count" => 0}
         end
         res
       end

data/lib/alchemy/test_support/config_stubbing.rb

@@ -17,13 +17,7 @@ module Alchemy
       # @param value [Object] The value you want to return instead of the original one
       #
       def stub_alchemy_config(key, value)
-        allow(Alchemy::Config).to receive(:get) do |arg|
-          if arg == key
-            value
-          else
-            Alchemy::Config.show[arg.to_s]
-          end
-        end
+        allow(Alchemy.config).to receive(key).and_return(value)
       end
     end
   end

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

@@ -2,9 +2,20 @@
 
 FactoryBot.define do
   factory :alchemy_attachment, class: "Alchemy::Attachment" do
-    file do
-      File.new(Alchemy::Engine.root.join("lib", "alchemy", "test_support", "fixtures", "image.png"))
+    transient do
+      file do
+        Rack::Test::UploadedFile.new(
+          Alchemy::Engine.root.join("lib", "alchemy", "test_support", "fixtures", "image.png")
+        )
+      end
     end
+
+    after(:build) do |attachment, acc|
+      if acc.file
+        attachment.file = acc.file
+      end
+    end
+
     name { "image" }
     file_name { "image.png" }
   end

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

@@ -6,7 +6,7 @@ FactoryBot.define do
     code { ::I18n.available_locales.first.to_s }
     default { true }
     frontpage_name { "Intro" }
-    page_layout { Alchemy::Config.get(:default_language)["page_layout"] }
+    page_layout { Alchemy.config.default_language.page_layout }
 
     public { true }