alchemy_cms 7.4.10 → 8.0.0.b

data/lib/alchemy.rb

@@ -2,190 +2,203 @@
 
 require "alchemy/admin/preview_url"
 require "importmap-rails"
+require "alchemy/configurations/main"
+require "alchemy/config_missing"
 
 module Alchemy
+  include Alchemy::ConfigMissing
+  extend Alchemy::ConfigMissing
+
   YAML_PERMITTED_CLASSES = %w[Symbol Date Regexp]
 
-  # Define page preview sources
-  #
-  # A preview source is a Ruby class returning an URL
-  # that is used as source for the preview frame in the
-  # admin UI.
-  #
-  # == Example
-  #
-  #     # lib/acme/preview_source.rb
-  #     class Acme::PreviewSource < Alchemy::Admin::PreviewUrl
-  #       def url_for(page)
-  #         if page.site.name == "Next"
-  #           "https://user:#{ENV['PREVIEW_HTTP_PASS']}@next.acme.com"
-  #         else
-  #           "https://www.acme.com"
-  #         end
-  #       end
-  #     end
-  #
-  #     # config/initializers/alchemy.rb
-  #     require "acme/preview_source"
-  #     Alchemy.preview_sources << Acme::PreviewSource
-  #
-  #     # config/locales/de.yml
-  #     de:
-  #       activemodel:
-  #         models:
-  #           acme/preview_source: Acme Vorschau
-  #
-  def self.preview_sources
-    @_preview_sources ||= Set.new << Alchemy::Admin::PreviewUrl
-  end
+  # JS Importmap instance
+  singleton_class.attr_accessor :importmap
+  self.importmap = Importmap::Map.new
 
-  def self.preview_sources=(sources)
-    @_preview_sources = Array(sources)
-  end
+  mattr_accessor :storage_adapter
 
-  # Additional JS modules to be imported in the Alchemy admin UI
-  #
-  # Be sure to also pin the modules with +Alchemy.importmap+.
-  #
-  # == Example
-  #
-  #    Alchemy.importmap.pin "flatpickr/de",
-  #      to: "https://ga.jspm.io/npm:flatpickr@4.6.13/dist/l10n/de.js"
-  #
-  #    Alchemy.admin_js_imports << "flatpickr/de"
-  #
-  def self.admin_js_imports
-    @_admin_js_imports ||= Set.new
-  end
+  class << self
+    def config
+      @_config ||= Alchemy::Configurations::Main.new
+    end
 
-  def self.admin_js_imports=(sources)
-    @_admin_js_imports = Set[sources]
-  end
+    def configure(&blk)
+      yield config
+    end
 
-  # Additional importmaps to be included in the Alchemy admin UI
-  #
-  # Be sure to also pin modules with +Alchemy.importmap+.
-  #
-  # == Example
-  #
-  #    # config/alchemy/importmap.rb
-  #    Alchemy.importmap.pin "alchemy_solidus", to: "alchemy_solidus.js", preload: true
-  #    Alchemy.importmap.pin_all_from Alchemy::Solidus::Engine.root.join("app/javascript/alchemy_solidus"),
-  #      under: "alchemy_solidus",
-  #      preload: true
-  #
-  #    # lib/alchemy/solidus/engine.rb
-  #    initializer "alchemy_solidus.assets", before: "alchemy.importmap" do |app|
-  #      Alchemy.admin_importmaps.add({
-  #        importmap_path: root.join("config/importmap.rb"),
-  #        source_paths: [
-  #          root.join("app/javascript")
-  #        ],
-  #        name: "alchemy_solidus"
-  #      })
-  #      app.config.assets.precompile << "alchemy_solidus/manifest.js"
-  #    end
-  #
-  # @return [Set<Hash>]
-  def self.admin_importmaps
-    @_admin_importmaps ||= Set.new([{
-      importmap_path: Engine.root.join("config/importmap.rb"),
-      source_paths: [
-        Engine.root.join("app/javascript"),
-        Engine.root.join("vendor/javascript")
-      ],
-      name: "alchemy_admin"
-    }])
-  end
+    enable_searchable_deprecation_msg = "Use `Alchemy.config.show_page_searchable_checkbox` instead."
+    def enable_searchable = config.show_page_searchable_checkbox
+    deprecate :enable_searchable= => enable_searchable_deprecation_msg, :deprecator => Alchemy::Deprecation
 
-  # Additional stylesheets to be included in the Alchemy admin UI
-  #
-  # == Example
-  #
-  #    # lib/alchemy/devise/engine.rb
-  #    initializer "alchemy.devise.stylesheets", before: "alchemy.admin_stylesheets" do
-  #      Alchemy.admin_stylesheets << "alchemy/devise/admin.css"
-  #    end
-  #
-  # @return [Set<String>]
-  def self.admin_stylesheets
-    @_admin_stylesheets ||= Set.new(["alchemy/admin/custom.css"])
-  end
+    def enable_searchable=(other)
+      config.show_page_searchable_checkbox = other
+    end
+    deprecate enable_searchable: enable_searchable_deprecation_msg, deprecator: Alchemy::Deprecation
 
-  # Define page publish targets
-  #
-  # A publish target is a ActiveJob that gets performed
-  # whenever a user clicks the publish page button.
-  #
-  # Use this to trigger deployment hooks of external
-  # services in an asychronous way.
-  #
-  # == Example
-  #
-  #     # app/jobs/publish_job.rb
-  #     class PublishJob < ApplicationJob
-  #       def perform(page)
-  #         RestClient.post(ENV['BUILD_HOOK_URL'])
-  #       end
-  #     end
-  #
-  #     # config/initializers/alchemy.rb
-  #     Alchemy.publish_targets << PublishJob
-  #
-  def self.publish_targets
-    @_publish_targets ||= Set.new
-  end
+    # Define page preview sources
+    #
+    # A preview source is a Ruby class returning an URL
+    # that is used as source for the preview frame in the
+    # admin UI.
+    #
+    # == Example
+    #
+    #     # lib/acme/preview_source.rb
+    #     class Acme::PreviewSource < Alchemy::Admin::PreviewUrl
+    #       def url_for(page)
+    #         if page.site.name == "Next"
+    #           "https://user:#{ENV['PREVIEW_HTTP_PASS']}@next.acme.com"
+    #         else
+    #           "https://www.acme.com"
+    #         end
+    #       end
+    #     end
+    #
+    #     # config/initializers/alchemy.rb
+    #     require "acme/preview_source"
+    #     Alchemy.preview_sources << Acme::PreviewSource
+    #
+    #     # config/locales/de.yml
+    #     de:
+    #       activemodel:
+    #         models:
+    #           acme/preview_source: Acme Vorschau
+    #
+    def preview_sources
+      @_preview_sources ||= Set.new << Alchemy::Admin::PreviewUrl
+    end
 
-  # 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.enable_searchable = true
-  #
-  mattr_accessor :enable_searchable, default: false
+    def preview_sources=(sources)
+      @_preview_sources = Array(sources)
+    end
 
-  # JS Importmap instance
-  singleton_class.attr_accessor :importmap
-  self.importmap = Importmap::Map.new
+    # Additional JS modules to be imported in the Alchemy admin UI
+    #
+    # Be sure to also pin the modules with +Alchemy.importmap+.
+    #
+    # == Example
+    #
+    #    Alchemy.importmap.pin "flatpickr/de",
+    #      to: "https://ga.jspm.io/npm:flatpickr@4.6.13/dist/l10n/de.js"
+    #
+    #    Alchemy.admin_js_imports << "flatpickr/de"
+    #
+    def admin_js_imports
+      @_admin_js_imports ||= Set.new
+    end
+
+    def admin_js_imports=(sources)
+      @_admin_js_imports = Set[sources]
+    end
+
+    # Additional importmaps to be included in the Alchemy admin UI
+    #
+    # Be sure to also pin modules with +Alchemy.importmap+.
+    #
+    # == Example
+    #
+    #    # config/alchemy/importmap.rb
+    #    Alchemy.importmap.pin "alchemy_solidus", to: "alchemy_solidus.js", preload: true
+    #    Alchemy.importmap.pin_all_from Alchemy::Solidus::Engine.root.join("app/javascript/alchemy_solidus"),
+    #      under: "alchemy_solidus",
+    #      preload: true
+    #
+    #    # lib/alchemy/solidus/engine.rb
+    #    initializer "alchemy_solidus.assets", before: "alchemy.importmap" do |app|
+    #      Alchemy.admin_importmaps.add({
+    #        importmap_path: root.join("config/importmap.rb"),
+    #        source_paths: [
+    #          root.join("app/javascript")
+    #        ],
+    #        name: "alchemy_solidus"
+    #      })
+    #      app.config.assets.precompile << "alchemy_solidus/manifest.js"
+    #    end
+    #
+    # @return [Set<Hash>]
+    def admin_importmaps
+      @_admin_importmaps ||= Set.new([{
+        importmap_path: Engine.root.join("config/importmap.rb"),
+        source_paths: [
+          Engine.root.join("app/javascript"),
+          Engine.root.join("vendor/javascript")
+        ],
+        name: "alchemy_admin"
+      }])
+    end
+
+    # Additional stylesheets to be included in the Alchemy admin UI
+    #
+    # == Example
+    #
+    #    # lib/alchemy/devise/engine.rb
+    #    initializer "alchemy.devise.stylesheets", before: "alchemy.admin_stylesheets" do
+    #      Alchemy.admin_stylesheets << "alchemy/devise/admin.css"
+    #    end
+    #
+    # @return [Set<String>]
+    def admin_stylesheets
+      @_admin_stylesheets ||= Set.new(["alchemy/admin/custom.css"])
+    end
+
+    # Define page publish targets
+    #
+    # A publish target is a ActiveJob that gets performed
+    # whenever a user clicks the publish page button.
+    #
+    # Use this to trigger deployment hooks of external
+    # services in an asychronous way.
+    #
+    # == Example
+    #
+    #     # app/jobs/publish_job.rb
+    #     class PublishJob < ApplicationJob
+    #       def perform(page)
+    #         RestClient.post(ENV['BUILD_HOOK_URL'])
+    #       end
+    #     end
+    #
+    #     # config/initializers/alchemy.rb
+    #     Alchemy.publish_targets << PublishJob
+    #
+    def publish_targets
+      @_publish_targets ||= Set.new
+    end
 
-  # Configure tabs in the link dialog
-  #
-  # With this configuration that tabs in the link dialog can be extended
-  # without overwriting or defacing the Admin Interface.
-  #
-  # == Example
-  #
-  #    # components/acme/link_tab.rb
-  #    module Acme
-  #      class LinkTab < ::Alchemy::Admin::LinkDialog::BaseTab
-  #        def title
-  #          "Awesome Tab Title"
-  #        end
-  #
-  #        def name
-  #          :unique_name
-  #        end
-  #
-  #        def fields
-  #           [ title_input, target_select ]
-  #        end
-  #      end
-  #    end
-  #
-  #    # config/initializers/alchemy.rb
-  #    Alchemy.link_dialog_tabs << Acme::LinkTab
-  #
-  def self.link_dialog_tabs
-    @_link_dialog_tabs ||= Set.new([
-      Alchemy::Admin::LinkDialog::InternalTab,
-      Alchemy::Admin::LinkDialog::AnchorTab,
-      Alchemy::Admin::LinkDialog::ExternalTab,
-      Alchemy::Admin::LinkDialog::FileTab
-    ])
+    # Configure tabs in the link dialog
+    #
+    # With this configuration that tabs in the link dialog can be extended
+    # without overwriting or defacing the Admin Interface.
+    #
+    # == Example
+    #
+    #    # components/acme/link_tab.rb
+    #    module Acme
+    #      class LinkTab < ::Alchemy::Admin::LinkDialog::BaseTab
+    #        def title
+    #          "Awesome Tab Title"
+    #        end
+    #
+    #        def name
+    #          :unique_name
+    #        end
+    #
+    #        def fields
+    #           [ title_input, target_select ]
+    #        end
+    #      end
+    #    end
+    #
+    #    # config/initializers/alchemy.rb
+    #    Alchemy.link_dialog_tabs << Acme::LinkTab
+    #
+    def link_dialog_tabs
+      @_link_dialog_tabs ||= Set.new([
+        Alchemy::Admin::LinkDialog::InternalTab,
+        Alchemy::Admin::LinkDialog::AnchorTab,
+        Alchemy::Admin::LinkDialog::ExternalTab,
+        Alchemy::Admin::LinkDialog::FileTab
+      ])
+    end
   end
 end

data/lib/alchemy_cms.rb

@@ -7,16 +7,15 @@ require "alchemy"
 require "acts_as_list"
 require "action_view/dependency_tracker"
 require "active_model_serializers"
+require "active_storage/engine"
 require "awesome_nested_set"
 require "cancan"
 require "dragonfly"
 require "gutentag"
 require "importmap-rails"
 require "kaminari"
-require "non_stupid_digest_assets"
 require "ransack"
 require "simple_form"
-require "sprockets/rails"
 require "turbo-rails"
 require "userstamp"
 require "view_component"
@@ -27,11 +26,9 @@ require_relative "alchemy/admin/locale"
 require_relative "alchemy/admin/preview_url"
 require_relative "alchemy/auth_accessors"
 require_relative "alchemy/cache_digests/template_tracker"
-require_relative "alchemy/config"
 require_relative "alchemy/configuration_methods"
 require_relative "alchemy/controller_actions"
 require_relative "alchemy/deprecation"
-require_relative "alchemy/element_definition"
 require_relative "alchemy/elements_finder"
 require_relative "alchemy/error_tracking"
 require_relative "alchemy/errors"
@@ -44,11 +41,8 @@ require_relative "alchemy/modules"
 require_relative "alchemy/name_conversions"
 require_relative "alchemy/on_page_layout"
 require_relative "alchemy/on_page_layout/callbacks_runner"
-require_relative "alchemy/page_layout"
 require_relative "alchemy/paths"
 require_relative "alchemy/permissions"
-require_relative "alchemy/resource"
-require_relative "alchemy/searchable_resource"
 require_relative "alchemy/tinymce"
 require_relative "alchemy/taggable"
 require_relative "alchemy/version"

data/lib/generators/alchemy/ingredient/ingredient_generator.rb

@@ -24,9 +24,6 @@ module Alchemy
 
       def copy_templates
         @ingredient_editor_local = "#{file_name}_editor"
-        @ingredient_view_local = "#{file_name}_view"
-        @ingredient_view_component_class = "#{@class_name}View"
-        template "view.html.erb", "#{@ingredients_view_path}/_#{file_name}_view.html.erb"
         template "editor.html.erb", "#{@ingredients_view_path}/_#{file_name}_editor.html.erb"
       end
 

data/lib/generators/alchemy/install/files/_article.html.erb

@@ -1,7 +1,9 @@
 <%- cache(article) do -%>
-  <%= element_view_for(article, tag: 'article') do |el| -%>
-    <h2><%= el.render :headline %></h2>
-    <%= el.render :picture, size: '1200x600' %>
-    <%= el.render :text %>
+  <%= element_view_for(article, tag: "article", class: "w-full max-w-xl mx-auto bg-slate-100 shadow my-8 px-8 py-4 rounded") do |el| -%>
+    <%= el.render :headline, {}, class: "text-2xl font-bold my-4" %>
+    <%= el.render :picture %>
+    <div class="[&>p]:my-2 [&>h2]:font-bold [&>h2]:text-xl [&>h2]:my-4 [&>h3]:font-bold [&>h3]:my-2 [&>ul]:list-disc [&>ul]:ml-4 [&>p>a]:underline [&>p>code]:text-sm [&>p>code]:bg-gray-50 [&>p>code]:p-1 [&>p>code]:whitespace-nowrap">
+      <%= el.render :text %>
+    </div>
   <%- end -%>
 <%- end -%>

data/lib/generators/alchemy/install/files/alchemy.en.yml

@@ -17,14 +17,33 @@ en:
     # Default texts for new ingredients created
     default_ingredient_texts:
       article_headline: "Welcome to your first Alchemy CMS page"
-      article_text: '<p><strong>How to get started.</strong></p><p>First of all you should read about Alchemy and its architecture in the <a class="external" href="http://guides.alchemy-cms.com/alchemy_approach.html" target="_blank" data-link-target="blank">guidelines</a>.</p><p>The most important things to know about Alchemy are elements and page layouts.</p><p><span style="text-decoration: underline;"><strong>Elements:</strong></span></p><p>With Alchemy you can split pages into content parts, elements. These elements can be defined out of several base content types: ingredients. The ingredients are:</p><ul><li>Text - <em>A single line of text</em></li><li>Richtext - <em>A TinyMCE powered formatted text block</em></li><li>Picture - <em>A reference to an image</em></li><li>Html - <em>HTML embed code</em></li><li>Select - <em>A selection of values</em></li><li>Boolean - <em>A checkbox</em></li></ul><p>Elements get defined in a YAML file <strong>config/alchemy/elements.yml</strong></p><p><a class="external" href="http://guides.alchemy-cms.com/elements.html" target="_blank" data-link-target="blank">Read more about elements and how to define them in the guidelines.</a></p><p><span style="text-decoration: underline;"><strong>Page types:</strong></span></p><p>You can define several types of pages, called page layouts. You can assign elements to page layouts and control how elements and the page of a certain layout behave.</p><p>Page layouts get defined in a YAML file <strong>config/alchemy/page_layouts.yml</strong></p><p><a class="external" href="http://guides.alchemy-cms.com/page_layouts.html" target="_blank" data-link-target="blank">Read more about defining page layouts in the guidelines.</a></p>'
+      article_text: |
+        <h2>How to get started.</h2>
+        <p>First of all you should read about Alchemy and it's architecture <a class="external" href="https://guides.alchemy-cms.com/alchemy_approach.html" target="_blank" rel="noopener" data-link-target="blank">in the guidelines</a>.</p>
+        <p>The most important things to know about Alchemy are elements and page layouts.</p>
+        <h3>Elements:</h3>
+        <p>With Alchemy you can split pages into content parts, elements. These elements can be defined out of several base content types: ingredients. The ingredients are:</p>
+        <ul>
+          <li>Text - <em>A single line of text</em></li>
+          <li>Richtext - <em>A TinyMCE powered formatted text block</em></li>
+          <li>Picture - <em>A reference to an image</em></li>
+          <li>Html - <em>HTML embed code</em></li>
+          <li>Select - <em>A selection of values</em></li>
+          <li>Boolean - <em>A checkbox</em></li>
+        </ul>
+        <p>Elements get defined in <code>config/alchemy/elements.yml</code>.</p>
+        <p>Read more about elements and how to define them <a class="external" href="https://guides.alchemy-cms.com/elements.html" target="_blank" rel="noopener" data-link-target="blank">in the guidelines</a>.</p>
+        <h3>Page types:</h3>
+        <p>You can define several types of pages, called page layouts. You can assign elements to page layouts and control how elements and the page of a certain layout behave.</p>
+        <p>Page layouts get defined in <code>config/alchemy/page_layouts.yml</code>.</p>
+        <p>Read more about defining page layouts <a class="external" href="https://guides.alchemy-cms.com/page_layouts.html" target="_blank" rel="noopener" data-link-target="blank">in the guidelines</a>.</p>
 
     # Hint texts for elements
     element_hints:
-      article: "This is a hint text for the article element. You can change this text in `config/locales/alchemy.en.yml`. Feel free to change it as you like, it's yours."
+      article: "This is a hint text for the article element. You can change this text in <code>config/locales/alchemy.en.yml</code>. Feel free to change it as you like, it's yours."
 
     # Hint texts for ingredients
     ingredient_hints:
       headline: "This is a single line of unformatable Text"
       picture: "Pictures are stored in the library. You can assign a picture multiple times throughout your site. Alchemy has an image cropper build right in."
-      text: "This is a rich text block powered by TinyMCE editor. You can change the configuration of the editor. See http://guides.alchemy-cms.com/customize_tinymce.html"
+      text: "This is a rich text block powered by TinyMCE editor. You can change the configuration of the editor. See https://guides.alchemy-cms.com/customize_tinymce.html"

data/lib/generators/alchemy/install/files/application.html.erb

@@ -7,6 +7,11 @@
 
     <%= stylesheet_link_tag 'application', media: 'all', 'data-turbo-track': 'reload' %>
     <%= javascript_include_tag 'application', 'data-turbo-track': 'reload' %>
+    <!--
+      Inserted by Alchemy demo file installer.
+      You probably want to remove this and use your custom css.
+    -->
+    <script src="https://cdn.tailwindcss.com"></script>
   </head>
 
   <body>

data/lib/generators/alchemy/install/install_generator.rb

@@ -53,18 +53,28 @@ module Alchemy
         install_tasks.inject_routes(options[:auto_accept])
       end
 
-      def copy_config
-        copy_file "#{gem_config_path}/config.yml", app_config_path.join("alchemy", "config.yml")
-      end
-
       def copy_yml_files
         %w[elements page_layouts menus].each do |file|
           template "#{__dir__}/templates/#{file}.yml.tt", app_config_path.join("alchemy", "#{file}.yml")
         end
       end
 
+      def copy_config_rb
+        @default_language = get_primary_language(
+          code: options[:default_language_code],
+          name: options[:default_language_name],
+          auto_accept: options[:auto_accept]
+        )
+        @default_config = Alchemy::Configurations::Main.new(
+          default_language: {
+            name: @default_language[:name],
+            code: @default_language[:code]
+          }
+        )
+        template "#{__dir__}/templates/alchemy.rb.tt", app_config_path.join("initializers", "alchemy.rb")
+      end
+
       def install_assets
-        copy_file "all.js", app_vendor_assets_path.join("javascripts", "alchemy", "admin", "all.js")
         copy_file "custom.css", app_assets_path.join("stylesheets/alchemy/admin/custom.css")
       end
 
@@ -72,15 +82,6 @@ module Alchemy
         return if options[:skip_demo_files]
 
         copy_file "application.html.erb", app_views_path.join("layouts", "application.html.erb")
-        copy_file "article.css", app_assets_path.join("stylesheets", "alchemy", "elements", "_article.css")
-
-        stylesheet_require = %(@import "alchemy/elements/article";\n)
-        if File.exist?(app_assets_path.join("stylesheets", "application.css"))
-          prepend_file app_assets_path.join("stylesheets", "application.css"), stylesheet_require
-        else
-          create_file app_assets_path.join("stylesheets", "application.css"), stylesheet_require
-        end
-
         copy_file "_article.html.erb", app_views_path.join("alchemy", "elements", "_article.html.erb")
         copy_file "_standard.html.erb", app_views_path.join("alchemy", "page_layouts", "_standard.html.erb")
         copy_file "alchemy.en.yml", app_config_path.join("locales", "alchemy.en.yml")
@@ -98,15 +99,6 @@ module Alchemy
         rake "gutentag:install:migrations"
       end
 
-      def set_primary_language
-        header
-        install_tasks.set_primary_language(
-          code: options[:default_language_code],
-          name: options[:default_language_name],
-          auto_accept: options[:auto_accept]
-        )
-      end
-
       def setup_database
         rake("db:create", abort_on_failure: true) unless options[:skip_db_create]
         # We can't invoke this rake task, because Rails will use wrong engine names otherwise
@@ -127,6 +119,16 @@ module Alchemy
 
       private
 
+      def get_primary_language(code: "en", name: "English", auto_accept: false)
+        unless options[:auto_accept]
+          code = ask("- What is the language code of your site's primary language?", default: code)
+        end
+        unless options[:auto_accept]
+          name = ask("- What is the name of your site's primary language?", default: name)
+        end
+        {code:, name:}
+      end
+
       def header
         return if options[:auto_accept]